Skip to content

gh-72406: Document argument ordering in argparse help output #148534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
savannahostrowski merged 5 commits into from
Apr 14, 2026
+3 −0
Merged

gh-72406: Document argument ordering in argparse help output #148534

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5add876
gh-72406: Document argument ordering in argparse help output
santihdzs Apr 13, 2026
016b619
Add NEWS entry
santihdzs Apr 13, 2026
c66f20b
Fix missing newline in NEWS entry
santihdzs Apr 13, 2026
4f72246
Move note to Argument groups section, remove NEWS entry
santihdzs Apr 14, 2026
e48d196
Merge branch 'main' into gh-72406-argparse-help-order
savannahostrowski Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -699,6 +699,8 @@ The add_argument() method
* deprecated_ - Whether or not use of the argument is deprecated.

The method returns an :class:`Action` object representing the argument.
Within each argument group, arguments are displayed in help output in the
order in which they are added.

The following sections describe how each of these are used.

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2026-04-13-15-50-00.gh-issue-72406.Xk9mPq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document that arguments are displayed in help output in the order they were added within each argument group.
Loading