Title: [idea] Ease understanding of positional-only and keyword-only makers in function prototyes · Issue #98340 · python/cpython · GitHub
Open Graph Title: [idea] Ease understanding of positional-only and keyword-only makers in function prototyes · Issue #98340 · python/cpython
X Title: [idea] Ease understanding of positional-only and keyword-only makers in function prototyes · Issue #98340 · python/cpython
Description: Documentation In https://docs.python.org/dev/library/functions.html I added many / and * markers in function prototypes. There were already a few of them here, and I bet there is some in other places in the doc too. For newcomers it may ...
Open Graph Description: Documentation In https://docs.python.org/dev/library/functions.html I added many / and * markers in function prototypes. There were already a few of them here, and I bet there is some in other plac...
X Description: Documentation In https://docs.python.org/dev/library/functions.html I added many / and * markers in function prototypes. There were already a few of them here, and I bet there is some in other plac...
Opengraph URL: https://github.com/python/cpython/issues/98340
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[idea] Ease understanding of positional-only and keyword-only makers in function prototyes ","articleBody":"# Documentation\r\n\r\nIn https://docs.python.org/dev/library/functions.html I added many `/` and `*` markers in function prototypes. There were already a few of them here, and I bet there is some in other places in the doc too.\r\n\r\nFor newcomers it may look like a typo, and it may be hard for them to discover what it means.\r\n\r\nI think it would be nice to tell them what it is, maybe by making all markers a link to the [glossary](https://docs.python.org/dev/glossary.html#term-parameter) or by displaying a message on mouse hover like « The parameters on the left of a / are positional-only. ».\r\n","author":{"url":"https://github.com/JulienPalard","@type":"Person","name":"JulienPalard"},"datePublished":"2022-10-16T19:25:14.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":5},"url":"https://github.com/98340/cpython/issues/98340"}| 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:a573b851-afd7-98b1-e227-5cd6678a4e2f |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B0B6:2373EB:3FEB8F8:5A4FB6B:6A4FAE67 |
| html-safe-nonce | 4d6a9af814232c4391aa4a419281c95101fef747948747787c86f04ec9e82cfe |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCMEI2OjIzNzNFQjozRkVCOEY4OjVBNEZCNkI6NkE0RkFFNjciLCJ2aXNpdG9yX2lkIjoiNTMxNTg4ODQyNzQzOTAxNzk5IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 9f8602d08fbbe5a72b0804224bc47a5c257ed92f67717046a9c8ffca0f7a1754 |
| hovercard-subject-tag | issue:1410593828 |
| 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/98340/issue_layout |
| twitter:image | https://opengraph.githubassets.com/3e5a00060c52038c42d4dd0950e233e656ce68e9e840dc329313d92903e38e9b/python/cpython/issues/98340 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/3e5a00060c52038c42d4dd0950e233e656ce68e9e840dc329313d92903e38e9b/python/cpython/issues/98340 |
| og:image:alt | Documentation In https://docs.python.org/dev/library/functions.html I added many / and * markers in function prototypes. There were already a few of them here, and I bet there is some in other plac... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | JulienPalard |
| hostname | github.com |
| expected-hostname | github.com |
| None | b92d11c0aa4a77d54ef4af1078b6a15fb5a70a215b30c4ecf28889d5a8e656d9 |
| 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 | 4b249b445842943ed31549e027f57a8ade9881ed |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width