Repository navigation
Conversation
Member
|
Please also do the same for |
Documentation build overview
|
StanFromIreland
approved these changes
Oct 25, 2026
StanFromIreland
left a comment
Member
There was a problem hiding this comment.
LGTM, I think this is a nice improvement, it will solve the mistaken-translation issue, and makes it clearer overall that these are parameters:
Any thoughts @savannahostrowski ?
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
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.
Closes #126031.
Mark the 15
ArgumentParserconstructor parameter headings and the 12add_argument()parameter headings as inline code. Their extracted translation messages currently contain bare words such asdescription,usage, andaction; literal markup identifies them as API parameter names, following the approach discussed in the issue. In thename or flagsheading, onlynameandflagsare formatted as code.The section structure and existing links are preserved. This adds a translation cue; the messages remain available for translation.
Validation on Windows with Python 3.12 and Sphinx 8.2.3:
python -m sphinx -q -W --keep-going -b html -d build/doctrees-html . build/html(fromDoc).python -m sphinx -q -W --keep-going -b gettext -d build/doctrees-gettext . build/gettext library/argparse.rst(fromDoc).python -m sphinxlint --enable=default-role Doc/library/argparse.rst,git diff --check, andpython -m pip check.AI assistance: OpenAI Codex prepared the documentation edits and performed the local builds and output verification.