Closed
Description
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
- gh-102810 Add docstrings to the public facing methods of the Timeout class #102811
- [3.11] gh-102810: Add docstrings to the public-facing methods of
asyncio.Timeout
(GH-102811) #102834 - gh-102810 Improve the sphinx docs for
asyncio.Timeout
#102934 - [3.11] gh-102810 Improve the sphinx docs for
asyncio.Timeout
(GH-102934) #102958
Metadata
Metadata
Assignees
Labels
Projects
Status
Done