Correct asyncio ref documentation for Python 3.11+ #54157
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
|
|
Signed-off-by: David Wagner <david@wagnerkc.com>
62219b9 to
413d98a
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR updates the async actor docs to explicitly call out asyncio patterns supported in different Python versions and moves the external asyncio link below the examples.
- Clarify how to wait on an
ObjectRefin Python 3.9 and 3.10 - Show direct
Futureobject usage in Python 3.11+ - Relocate the reference to the official asyncio docs after both examples
Comments suppressed due to low confidence (2)
doc/source/ray-core/actors/async_api.rst:107
- [nitpick] Consider renaming this heading to 'Wait on ObjectRef (Python 3.9 & 3.10):' for clarity, consistent casing, and to match the style of other subheadings.
you can wait on the ref (Python 3.9 and Python 3.10):
doc/source/ray-core/actors/async_api.rst:124
- [nitpick] To keep a parallel imperative style, you might use 'Access the Future object directly (Python 3.11+):' instead of starting with 'or'.
or the Future object directly (Python 3.11+):
angelinalg
approved these changes
Jun 26, 2025
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: David Wagner <david@wagnerkc.com>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: David Wagner <david@wagnerkc.com>
Signed-off-by: David Wagner <david@wagnerkc.com>
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.
Why are these changes needed?
Python 3.11+ issue identified in #31606 (comment), but not explicitly called out in docs leading to failure running this example: https://docs.ray.io/en/latest/ray-core/actors/async_api.html#objectrefs-as-asyncio-futures
Will come back to get all checks in place, figure out build locally, but will get some eyes on this change first.
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.