Skip to content

Commit 7c6730d

Browse files
committed
Add a return section to the docstring
1 parent c0af55f commit 7c6730d

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

shiny/ui/_chat.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -555,6 +555,13 @@ async def append_message_stream(self, message: Iterable[Any] | AsyncIterable[Any
555555
----
556556
Use this method (over `.append_message()`) when `stream=True` (or similar) is
557557
specified in model's completion method.
558+
559+
Returns
560+
-------
561+
reactive.ExtendedTask
562+
An extended task that represents the streaming task. The `.result()` method
563+
of the task can be called in a reactive context to get the final state of the
564+
stream.
558565
"""
559566

560567
message = _utils.wrap_async_iterable(message)

0 commit comments

Comments
 (0)