Skip to content

Minor documentation fix: incorrect statement about argparse.ArgumentParser.add_argument() #145479

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 4 commits into from
Mar 3, 2026
Merged

Minor documentation fix: incorrect statement about argparse.ArgumentParser.add_argument() #145479

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
07327c2
fix incorrect statement in argparse docs
jkunimune Mar 3, 2026
2e7ff21
adjust phrasing in argparse docs
jkunimune Mar 3, 2026
400df48
adjust linebreak in argparse docs
jkunimune Mar 3, 2026
1e0bfd0
Merge branch 'main' into patch-3
savannahostrowski Mar 3, 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
6 changes: 3 additions & 3 deletions Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -739,9 +739,9 @@ By default, :mod:`!argparse` automatically handles the internal naming and
display names of arguments, simplifying the process without requiring
additional configuration.
As such, you do not need to specify the dest_ and metavar_ parameters.
The dest_ parameter defaults to the argument name with underscores ``_``
replacing hyphens ``-`` . The metavar_ parameter defaults to the
upper-cased name. For example::
For optional arguments, the dest_ parameter defaults to the argument name, with underscores ``_``
replacing hyphens ``-``. The metavar_
parameter defaults to the upper-cased name. For example::

>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo-bar')
Expand Down
Loading