From: Serhiy Storchaka Date: Sat, 12 Oct 2024 11:53:00 +0000 (+0300) Subject: gh-85935: Explicitly document the case nargs=0 in argparse (GH-125302) X-Git-Tag: v3.14.0a1~64 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=07c2d15977738165e9dc4248e7edda7c75ecc14b;p=thirdparty%2FPython%2Fcpython.git gh-85935: Explicitly document the case nargs=0 in argparse (GH-125302) --- diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index 19f832051a9e..d58c75eef3e7 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -751,6 +751,9 @@ how the command-line arguments should be handled. The supplied actions are: .. versionadded:: 3.8 +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 other object that implements the same interface. The ``BooleanOptionalAction`` is available in ``argparse`` and adds support for boolean actions such as @@ -878,6 +881,8 @@ 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 (e.g. +``'store_const'``) set ``nargs=0``. .. _const: