docs: remove non-existent astream() method and fix concurrent agents example #103
Conversation
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
…example - Remove 'Async Streaming' section that documented astream() method which was never implemented - Update 'Concurrent Agents' example to use actual functions (run_conversation, callback) from the example code instead of undefined run_task() - Properly demonstrate concurrent execution using loop.run_in_executor() with asyncio.gather() Co-authored-by: openhands <openhands@all-hands.dev>
xingyaoww
approved these changes
Nov 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR fixes documentation issues in the SDK async guide (
sdk/guides/convo-async.mdx):conversation.astream()- a method that was never implemented in the codebaserun_task()Changes
Removed
astream()usage (lines 119-130)AttributeError: 'LocalConversation' object has no attribute 'astream'Updated
loop.run_in_executor()with the actualrun_conversationfunction defined in the exampleAsyncCallbackWrapperwithcallback_coroasyncio.gather()Background
The
astream()method was documented on October 22, 2025 (commit b419a23) as part of a large documentation standardization effort, but this API was never implemented in the actual SDK. The working example file (examples/01_standalone_sdk/11_async.py) uses the callback-based approach, notastream().This documentation fix aligns the docs with the actual SDK implementation and provides users with correct, working examples.
Related
astream()in OpenHands/software-agent-sdk@neubig can click here to continue refining the PR