Skip to content

Commit 1df86c4

Browse files
committed
Add return section to MarkdownStream() as well
1 parent 7c6730d commit 1df86c4

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

shiny/ui/_chat.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ async def append_message_stream(self, message: Iterable[Any] | AsyncIterable[Any
558558
559559
Returns
560560
-------
561-
reactive.ExtendedTask
561+
:
562562
An extended task that represents the streaming task. The `.result()` method
563563
of the task can be called in a reactive context to get the final state of the
564564
stream.

shiny/ui/_markdown_stream.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,13 @@ async def stream(
109109
----
110110
If you already have the content available as a string, you can do
111111
`.stream([content])` to set the content.
112+
113+
Returns
114+
-------
115+
:
116+
An extended task that represents the streaming task. The `.result()` method
117+
of the task can be called in a reactive context to get the final state of the
118+
stream.
112119
"""
113120

114121
content = _utils.wrap_async_iterable(content)

0 commit comments

Comments
 (0)