GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Possibly missing parameters in the documentation of asyncio functions · Issue #100248 · python/cpython

Possibly missing parameters in the documentation of asyncio functions #100248

New issue
Copy link
New issue
Copy link
Closed
#100249
Closed
Possibly missing parameters in the documentation of asyncio functions#100248
#100249
Copy link
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dir

Description

@busywhitespace
busywhitespace
opened on Dec 14, 2022
Issue body actions

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

  • gh-100248: Add missing ssl_shutdown_timeout parameter in asyncio docs #100249
  • [3.11] gh-100248: Add missing ssl_shutdown_timeout parameter in asyncio docs (GH-100249) #100250

Activity

  1. busywhitespace
    added
    docsDocumentation in the Doc dirDocumentation in the Doc dir
    on Dec 14, 2022
  2. kumaraditya303
    linked a pull request that will close this issuegh-100248: Add missing `ssl_shutdown_timeout` parameter in `asyncio` docs #100249on Dec 14, 2022
  3. kumaraditya303
    closed this as completedin #100249on Dec 14, 2022
  4. kumaraditya303
    added a commit that references this issue on Dec 14, 2022

    gh-100248: Add missing `ssl_shutdown_timeout` parameter in `asyncio` …

    9663853
  5. miss-islington
    added 2 commits that reference this issue on Dec 14, 2022

    pythongh-100248: Add missing `ssl_shutdown_timeout` parameter in `asy…

    612f8bf

    gh-100248: Add missing `ssl_shutdown_timeout` parameter in `asyncio` …

    cb1001c
  6. carljm
    added a commit that references this issue on Dec 14, 2022

    Merge branch 'main' into typedocs

    53d33a1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirDocumentation in the Doc dir

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      You are visitor 01402503 — GeezerVison does not store the pages you look up.
      Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.