gh-74366: Fix the documentation of $ in PyArg_ParseTupleAndKeywords() - #155301
Merged
serhiy-storchaka merged 2 commits intoAug 7, 2026
Conversation
…ywords() The keyword-only arguments are not always optional: they are required if "|" was not specified before "$". Document also that "|" cannot be specified after "$", and add examples for "|" and "$".
serhiy-storchaka
added
needs backport to 3.13
Documentation build overview
|
serhiy-storchaka
enabled auto-merge (squash)
August 7, 2026 04:00
|
Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15. |
|
GH-155308 is a backport of this pull request to the 3.15 branch. |
bedevere-app
Bot
removed
the
needs backport to 3.15
|
GH-155309 is a backport of this pull request to the 3.14 branch. |
|
GH-155310 is a backport of this pull request to the 3.13 branch. |
serhiy-storchaka
added a commit
that referenced
this pull request
Aug 7, 2026
…eywords() (GH-155301) (GH-155310) The keyword-only arguments are not always optional: they are required if "|" was not specified before "$". Document also that "|" cannot be specified after "$", and add examples for "|" and "$". (cherry picked from commit af930c1) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka
added a commit
that referenced
this pull request
Aug 7, 2026
…eywords() (GH-155301) (GH-155309) The keyword-only arguments are not always optional: they are required if "|" was not specified before "$". Document also that "|" cannot be specified after "$", and add examples for "|" and "$". (cherry picked from commit af930c1) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
hugovk
pushed a commit
that referenced
this pull request
Aug 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation says that all keyword-only arguments must also be optional, so
|must always be specified before$. This has never been true: if|is not specified before$, the keyword-only arguments are required. The wording dates back to the addition of$in 3.3 (bpo-14328) and has not been touched since.Document also that
|cannot be specified after$, and add examples of format strings with the corresponding Python signatures.