bpo-36999: Add asyncio.Task.get_coro() #13680
Merged
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
asvetlov
reviewed
May 30, 2019
Doc/library/asyncio-task.rst
Outdated
| @@ -842,6 +842,12 @@ Task Object | |||
| The *file* argument is an I/O stream to which the output | |||
| is written; by default output is written to :data:`sys.stderr`. | |||
|
|
|||
| .. method:: get_coro() | |||
|
|
|||
| Return the coroutine object that was passed to the constructor. | |||
There was a problem hiding this comment.
I dislike mentioning constructor here.
Above we have the text:
Use the high-level :func:`asyncio.create_task` function to create
Tasks, or the low-level :meth:`loop.create_task` or
:func:`ensure_future` functions. Manual instantiation of Tasks
is discouraged.
Maybe rephrase this line to Return the coroutine object that was used for the task creation. or something like this?
Sorry, I'm not a native speaker. Don't insist on the exact wording but you've got my idea.
There was a problem hiding this comment.
I'd just say this: "Return the coroutine object wrapped by the Task".
1st1
approved these changes
May 30, 2019
asvetlov
reviewed
May 30, 2019
Doc/library/asyncio-task.rst
Outdated
| @@ -842,6 +842,12 @@ Task Object | |||
| The *file* argument is an I/O stream to which the output | |||
| is written; by default output is written to :data:`sys.stderr`. | |||
|
|
|||
| .. method:: get_coro() | |||
|
|
|||
| Return the coroutine object that was passed to the constructor. | |||
There was a problem hiding this comment.
Suggested change
| Return the coroutine object that was passed to the constructor. | |
| Return the coroutine object wrapped by the :class:`Task`. |
@1st1 like this?
There was a problem hiding this comment.
Yeah, I think it's great. If you have time just merge Alex's PR and we can fix this ourselves. Up to you.
There was a problem hiding this comment.
I changed the wording now as requested.
asvetlov
approved these changes
May 30, 2019
|
Thanks! |
DinoV
pushed a commit
to DinoV/cpython
that referenced
this pull request
Jan 14, 2020
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.
https://bugs.python.org/issue36999