Skip to content

gh-89819: Add argument_default and conflict_handler to add_argument_group docs #125379

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
merged 8 commits into from
Oct 15, 2024
Merged

gh-89819: Add argument_default and conflict_handler to add_argument_group docs #125379

Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
31fe518
Add argument_default and conflict_handler to add_argument_group docs
savannahostrowski Oct 12, 2024
c25fca4
Address PR comments
savannahostrowski Oct 13, 2024
552be31
Merge branch 'main' into gh-89819
savannahostrowski Oct 13, 2024
65654bb
Add *
savannahostrowski Oct 13, 2024
9902098
Merge branch 'gh-89819' of https://github.com/savannahostrowski/cpyth…
savannahostrowski Oct 13, 2024
742b116
Make description more concise
savannahostrowski Oct 15, 2024
03b1ad2
Remove newline
savannahostrowski Oct 15, 2024
2cbf230
Lint
savannahostrowski Oct 15, 2024
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
8 changes: 7 additions & 1 deletion Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1808,7 +1808,8 @@ FileType objects
Argument groups
^^^^^^^^^^^^^^^

.. method:: ArgumentParser.add_argument_group(title=None, description=None)
.. method:: ArgumentParser.add_argument_group(title=None, description=None, *, \
[argument_default], [conflict_handler])

By default, :class:`ArgumentParser` groups command-line arguments into
"positional arguments" and "options" when displaying help
Expand Down Expand Up @@ -1853,6 +1854,11 @@ Argument groups

--bar BAR bar help

The optional, keyword-only parameters argument_default_ and conflict_handler_
allow for finer-grained control of the behavior of the argument group. These
parameters have the same meaning as in the :class:`~ArgumentParser` constructor,
but apply specifically to the argument group rather than the entire parser.

Note that any arguments not in your user-defined groups will end up back
in the usual "positional arguments" and "optional arguments" sections.

Expand Down
Loading