-
-
Notifications
You must be signed in to change notification settings - Fork 30.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docstrings to asyncio.Timeout #102810
Comments
(Process note for the future: We don't require issues for adding docs or docstrings -- we'll set the "skip issue" label on the PR. Though we might sometimes create such issues to solicit contributions. Anyway, I'll review the PR this weekend.) |
…meout` (#102811) Co-authored-by: Guido van Rossum <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
…cio.Timeout` (pythonGH-102811) (cherry picked from commit 699cb20) Co-authored-by: JosephSBoyle <[email protected]> Co-authored-by: Guido van Rossum <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
…meout` (GH-102811) (cherry picked from commit 699cb20) Co-authored-by: JosephSBoyle <[email protected]> Co-authored-by: Guido van Rossum <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
Closing as done, thanks for the help on this! |
#102811 (comment) is still to do! |
Aha okay, I was thinking of creating a new issue to plan the changes but I'll draft a PR sometime in the next couple of days and we can just discuss things on there:) |
Co-authored-by: Alex Waygood <[email protected]>
…GH-102934) (cherry picked from commit f13fdac) Co-authored-by: JosephSBoyle <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
(cherry picked from commit f13fdac) Co-authored-by: JosephSBoyle <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
Thanks @JosephSBoyle! |
…cio.Timeout` (python#102811) Co-authored-by: Guido van Rossum <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
…#102934) Co-authored-by: Alex Waygood <[email protected]>
…cio.Timeout` (python#102811) Co-authored-by: Guido van Rossum <[email protected]> Co-authored-by: Alex Waygood <[email protected]>
…#102934) Co-authored-by: Alex Waygood <[email protected]>
Feature or enhancement
asyncio.Timeout
doesn't have docstrings. (asyncio.timeout
does though:) )Pitch
Adding docstrings would increase the usability of this class.
Notes
I will open a PR for this shortly.
I envisage starting out copying from the docs: https://docs.python.org/3/library/asyncio-task.html#asyncio.Timeout
and hammering out the wording in the PR, similar to what was done for
asyncio.TaskGroup
in #102560.Linked PRs
asyncio.Timeout
(GH-102811) #102834asyncio.Timeout
#102934asyncio.Timeout
(GH-102934) #102958The text was updated successfully, but these errors were encountered: