Skip to content

Commit 895a640

Browse files
committed
Link to Bookmark class in docs; Add Returns
1 parent f51c0be commit 895a640

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

shiny/ui/_chat.py

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1422,9 +1422,9 @@ def enable_bookmarking(
14221422
Enable bookmarking for the chat instance.
14231423
14241424
This method registers `on_bookmark` and `on_restore` hooks on `session.bookmark`
1425-
to save/restore chat state on both the `Chat` and `client` instances.
1426-
In order for this method to actually work correctly, a `bookmark_store`
1427-
must be specified in `shiny.App()`.
1425+
(:class:`shiny.bookmark.Bookmark`) to save/restore chat state on both the `Chat`
1426+
and `client=` instances. In order for this method to actually work correctly, a
1427+
`bookmark_store=` must be specified in `shiny.App()`.
14281428
14291429
Parameters
14301430
----------
@@ -1445,6 +1445,11 @@ def enable_bookmarking(
14451445
------
14461446
ValueError
14471447
If the Shiny App does have bookmarking enabled.
1448+
1449+
Returns
1450+
-------
1451+
:
1452+
A callback to cancel the bookmarking hooks.
14481453
"""
14491454
from ..express._stub_session import ExpressStubSession
14501455

@@ -1680,9 +1685,9 @@ def enable_bookmarking(
16801685
Enable bookmarking for the chat instance.
16811686
16821687
This method registers `on_bookmark` and `on_restore` hooks on `session.bookmark`
1683-
to save/restore chat state on both the `Chat` and `client` instances.
1684-
In order for this method to actually work correctly, a `bookmark_store`
1685-
must be specified in `shiny.express.app_opts()`.
1688+
(:class:`shiny.bookmark.Bookmark`) to save/restore chat state on both the `Chat`
1689+
and `client=` instances. In order for this method to actually work correctly, a
1690+
`bookmark_store=` must be specified in `shiny.express.app_opts()`.
16861691
16871692
Parameters
16881693
----------
@@ -1706,6 +1711,11 @@ def enable_bookmarking(
17061711
------
17071712
ValueError
17081713
If the Shiny App does have bookmarking enabled.
1714+
1715+
Returns
1716+
-------
1717+
:
1718+
A callback to cancel the bookmarking hooks.
17091719
"""
17101720

17111721
if bookmark_store is not None:

0 commit comments

Comments
 (0)