Skip to content

Add docstrings to asyncio.Timeout #102810

Closed
Closed
@JosephSBoyle

Description

@JosephSBoyle

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.11only security fixes3.12bugs and security fixesstdlibPython modules in the Lib dirtopic-asynciotype-featureA feature request or enhancement

    Projects

    • Status

      Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions