Possibly missing parameters in the documentation of asyncio functions #100248
Labels
docs
Documentation in the Doc dir
Comments
kumaraditya303
pushed a commit
that referenced
this issue
Dec 14, 2022
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Dec 14, 2022
…ncio` docs (pythonGH-100249) (cherry picked from commit 9663853) Co-authored-by: busywhitespace <busywhitespace@tuta.io>
carljm
added a commit
to carljm/cpython
that referenced
this issue
Dec 14, 2022
* main: (103 commits) pythongh-100248: Add missing `ssl_shutdown_timeout` parameter in `asyncio` docs (python#100249) Assorted minor fixes for specialization stats. (pythonGH-100219) pythongh-100176: venv: Remove redundant compat code for Python <= 3.2 (python#100177) pythonGH-100222: Redefine _Py_CODEUNIT as a union to clarify structure of code unit. (pythonGH-100223) pythongh-99955: undef ERROR and SUCCESS before redefining (fixes sanitizer warning) (python#100215) pythonGH-100206: use versionadded for the addition of sysconfig.get_default_scheme (python#100207) pythongh-81057: Move _Py_RefTotal to the "Ignored Globals" List (pythongh-100203) pythongh-81057: Move Signal-Related Globals to _PyRuntimeState (pythongh-100085) pythongh-81057: Move faulthandler Globals to _PyRuntimeState (pythongh-100152) pythongh-81057: Move tracemalloc Globals to _PyRuntimeState (pythongh-100151) pythonGH-100143: Improve collecting pystats for parts of runs (pythonGH-100144) pythongh-99955: standardize return values of functions in compiler's code-gen (python#100010) pythongh-79218: Define `MS_WIN64` macro for Mingw-w64 64bit on Windows (pythonGH-100137) Fix: typo (Indention) (pythonGH-99904) pythongh-96715 Remove redundant NULL check in `profile_trampoline` function (python#96716) pythongh-100176: remove incorrect version compatibility check from argument clinic (python#100190) clarify the 4300-digit limit on int-str conversion (python#100175) pythongh-70393: Clarify mention of "middle" scope (python#98839) pythongh-99688: Fix outdated tests in test_unary (python#99712) pythongh-100174: [Enum] Correct PowersOfThree example. (pythonGH-100178) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
ssl_shutdown_timeoutparameter inasynciodocs #100249ssl_shutdown_timeoutparameter inasynciodocs (GH-100249) #100250The text was updated successfully, but these errors were encountered: