Skip to content

Possibly missing parameters in the documentation of asyncio functions #100248

Closed
@busywhitespace

Description

@busywhitespace

The functions asyncio.open_connection/start_server/open_unix_connection/start_unix_server call their "counterparts" in loop.

asyncio.open_connection calls loop.create_connection.
asyncio.start_server calls loop.create_server.
asyncio.open_unix_connection calls loop.create_unix_connection.
asyncio.start_unix_server calls loop.create_unix_server.

Thus the signatures in the documentation for open_* and start_* almost copy the signatures of their counterparts.

But 3.11 introduced ssl_shutdown_timeout parameter that is missing in the documentation of open_* and start_* functions. So I recommend putting it into the documentation of the aforementioned functions for the consistency reason.

I've created the PR in case the issue is right.

Linked PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions