Skip to content
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

Closed
JosephSBoyle opened this issue Mar 18, 2023 · 5 comments
Closed

Add docstrings to asyncio.Timeout #102810

JosephSBoyle opened this issue Mar 18, 2023 · 5 comments
Labels
3.11 only security fixes 3.12 bugs and security fixes stdlib Python modules in the Lib dir topic-asyncio type-feature A feature request or enhancement

Comments

@JosephSBoyle
Copy link
Contributor

JosephSBoyle commented Mar 18, 2023

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

@JosephSBoyle JosephSBoyle added the type-feature A feature request or enhancement label Mar 18, 2023
@AlexWaygood AlexWaygood added topic-asyncio stdlib Python modules in the Lib dir 3.11 only security fixes 3.12 bugs and security fixes labels Mar 18, 2023
@github-project-automation github-project-automation bot moved this to Todo in asyncio Mar 18, 2023
@gvanrossum
Copy link
Member

(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.)

AlexWaygood added a commit that referenced this issue Mar 19, 2023
…meout` (#102811)

Co-authored-by: Guido van Rossum <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 19, 2023
…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]>
miss-islington added a commit that referenced this issue Mar 19, 2023
…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]>
@JosephSBoyle
Copy link
Contributor Author

Closing as done, thanks for the help on this!

@github-project-automation github-project-automation bot moved this from Todo to Done in asyncio Mar 21, 2023
@AlexWaygood
Copy link
Member

Closing as done, thanks for the help on this!

#102811 (comment) is still to do!

@AlexWaygood AlexWaygood reopened this Mar 21, 2023
@github-project-automation github-project-automation bot moved this from Done to In Progress in asyncio Mar 21, 2023
@JosephSBoyle
Copy link
Contributor Author

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:)

AlexWaygood added a commit that referenced this issue Mar 23, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 23, 2023
…GH-102934)

(cherry picked from commit f13fdac)

Co-authored-by: JosephSBoyle <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
miss-islington added a commit that referenced this issue Mar 23, 2023
(cherry picked from commit f13fdac)

Co-authored-by: JosephSBoyle <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
@AlexWaygood
Copy link
Member

Thanks @JosephSBoyle!

@github-project-automation github-project-automation bot moved this from In Progress to Done in asyncio Mar 23, 2023
Fidget-Spinner pushed a commit to Fidget-Spinner/cpython that referenced this issue Mar 27, 2023
…cio.Timeout` (python#102811)

Co-authored-by: Guido van Rossum <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
Fidget-Spinner pushed a commit to Fidget-Spinner/cpython that referenced this issue Mar 27, 2023
warsaw pushed a commit to warsaw/cpython that referenced this issue Apr 11, 2023
…cio.Timeout` (python#102811)

Co-authored-by: Guido van Rossum <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
warsaw pushed a commit to warsaw/cpython that referenced this issue Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes 3.12 bugs and security fixes stdlib Python modules in the Lib dir topic-asyncio type-feature A feature request or enhancement
Projects
Status: Done
Development

No branches or pull requests

3 participants