docs: add docstrings to MessageStream and AsyncMessageStream#1321
Open
mastash3ff wants to merge 1 commit intoanthropics:mainfrom
Open
docs: add docstrings to MessageStream and AsyncMessageStream#1321mastash3ff wants to merge 1 commit intoanthropics:mainfrom
mastash3ff wants to merge 1 commit intoanthropics:mainfrom
Conversation
MessageStream and AsyncMessageStream are public classes used by callers of the streaming API, but their class-level docstrings and several property docstrings (response, request_id, current_message_snapshot) were missing. Add them so the classes are self-documenting in IDEs and generated API references.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
MessageStreamandAsyncMessageStreamare public classes exported fromanthropic.lib.streamingand used directly by callers of the streaming API.Both classes were missing class-level docstrings, and three properties on each
(
response,request_id,current_message_snapshot) had no documentation.Changes
MessageStreamdescribing usage as a context manager and available helpersAsyncMessageStream(async counterpart)response,request_id, andcurrent_message_snapshoton both classescurrent_message_snapshotdocstring notes theAssertionErrorraised if accessed before iteration starts