From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Sat, 12 Oct 2024 13:02:26 +0000 (+0200) Subject: [3.13] gh-85935: Explicitly document the case nargs=0 in argparse (GH-125302) (GH... X-Git-Tag: v3.13.1~319 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0542645354db6f072c1aee28a2c04927a8a0c002;p=thirdparty%2FPython%2Fcpython.git [3.13] gh-85935: Explicitly document the case nargs=0 in argparse (GH-125302) (GH-125357) (cherry picked from commit 07c2d15977738165e9dc4248e7edda7c75ecc14b) Co-authored-by: Serhiy Storchaka --- diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index d06264f72ee0..4e66611ab172 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -728,6 +728,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 @@ -855,6 +858,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: