Title: Possibly missing parameters in the documentation of asyncio functions · Issue #100248 · python/cpython · GitHub
Open Graph Title: Possibly missing parameters in the documentation of asyncio functions · Issue #100248 · python/cpython
X Title: Possibly missing parameters in the documentation of asyncio functions · Issue #100248 · python/cpython
Description: 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.ope...
Open Graph Description: 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_serv...
X Description: 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....
Opengraph URL: https://github.com/python/cpython/issues/100248
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Possibly missing parameters in the documentation of asyncio functions","articleBody":"The functions _asyncio_.**open_connection**/**start_server**/**open_unix_connection**/**start_unix_server** call their \"counterparts\" in *loop*.\r\n\r\n_asyncio_.**open_connection** calls _loop_.**create_connection**.\r\n_asyncio_.**start_server** calls _loop_.**create_server**.\r\n_asyncio_.**open_unix_connection** calls _loop_.**create_unix_connection**.\r\n_asyncio_.**start_unix_server** calls _loop_.**create_unix_server**.\r\n\r\nThus the signatures in the documentation for **open_\\*** and **start_\\*** almost copy the signatures of their counterparts.\r\n\r\nBut 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.\r\n\r\nI've created the PR in case the issue is right.\r\n\r\n\u003c!-- gh-linked-prs --\u003e\r\n### Linked PRs\r\n* gh-100249\r\n* gh-100250\n\u003c!-- /gh-linked-prs --\u003e\r\n","author":{"url":"https://github.com/busywhitespace","@type":"Person","name":"busywhitespace"},"datePublished":"2022-12-14T16:37:36.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/100248/cpython/issues/100248"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:f93bb3c1-5e00-d5b8-10ef-16dbf0a51747 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A072:26204A:A3FA01:DC4D74:696991DE |
| html-safe-nonce | 968940cc162e0d3048e52c05cfbd5815681d6ac8002f744b96a9a816c1322ba4 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBMDcyOjI2MjA0QTpBM0ZBMDE6REM0RDc0OjY5Njk5MURFIiwidmlzaXRvcl9pZCI6IjY1OTI5MzE0NzcyNDA1MTcwODYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 5a1b13be9bf2247ffaa39f300faf494e76bdfed80cf693a4fc8538b29d83b7c9 |
| hovercard-subject-tag | issue:1497003144 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/cpython/100248/issue_layout |
| twitter:image | https://opengraph.githubassets.com/1e07c4d9f5db3725016a27a01d84f18b1df35edeb9cf55efdc7acaa1417673a7/python/cpython/issues/100248 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/1e07c4d9f5db3725016a27a01d84f18b1df35edeb9cf55efdc7acaa1417673a7/python/cpython/issues/100248 |
| og:image:alt | 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_serv... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | busywhitespace |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3542e147982176a7ebaa23dfb559c8af16f721c03ec560c68c56b64a0f35e751 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | af80af7cc9e3de9c336f18b208a600950a3c187c |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width