Skip to content

gh-85935: Explicitly document the case nargs=0 in argparse #125302

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
serhiy-storchaka merged 2 commits into from
Oct 12, 2024
Merged

gh-85935: Explicitly document the case nargs=0 in argparse #125302

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
095c414
gh-85935: Excplicitly document the case nargs=0 in argparse
serhiy-storchaka Oct 11, 2024
81660a4
Apply suggestions from code review
serhiy-storchaka Oct 12, 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
Prev Previous commit
Apply suggestions from code review 
Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
  • Loading branch information
@serhiy-storchaka @savannahostrowski
serhiy-storchaka and savannahostrowski authored Oct 12, 2024
commit 81660a4d4463c1ee9a3e8a7849c0a5393a586ea4
4 changes: 2 additions & 2 deletions Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,7 +731,7 @@ how the command-line arguments should be handled. The supplied actions are:

.. versionadded:: 3.8

Only actions that consume command-line arguments (such as ``'store'``,
Only actions that consume command-line arguments (e.g. ``'store'``,
``'append'`` or ``'extend'``) can be used with positional arguments.

You may also specify an arbitrary action by passing an Action subclass or
Expand Down Expand Up @@ -861,7 +861,7 @@ See also :ref:`specifying-ambiguous-arguments`. The supported values are:
If the ``nargs`` keyword argument is not provided, the number of arguments consumed
is determined by the action_. Generally this means a single command-line argument
will be consumed and a single item (not a list) will be produced.
Actions that do not consume command-line arguments (such as
Actions that do not consume command-line arguments (e.g.
``'store_const'``) set ``nargs=0``.


Expand Down