Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-03-30 16:41:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

GH-141963: Clarify argparse documentation (GH-141964)

Browse source 
Clarify argparse documentation

Tightens the phrasing for several argparse actions.
This commit is contained in:
Moshe Kaplan 2025-11-29 02:23:34 -05:00 • committed by GitHub
parent 890fe5aad5
commit cfcd52490d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Doc/library/argparse.rst
View file

@ -767,9 +767,9 @@ how the command-line arguments should be handled. The supplied actions are:
Namespace(foo=42)
* ``'store_true'`` and ``'store_false'`` - These are special cases of
``'store_const'`` used for storing the values ``True`` and ``False``
respectively. In addition, they create default values of ``False`` and
``True`` respectively::
``'store_const'`` that respectively store the values ``True`` and ``False``
with default values of ``False`` and
``True``::
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_true')
@ -789,8 +789,8 @@ how the command-line arguments should be handled. The supplied actions are:
>>> parser.parse_args('--foo 1 --foo 2'.split())
Namespace(foo=['0', '1', '2'])
* ``'append_const'`` - This stores a list, and appends the value specified by
the const_ keyword argument to the list; note that the const_ keyword
* ``'append_const'`` - This appends the value specified by
the const_ keyword argument to a list; note that the const_ keyword
argument defaults to ``None``. The ``'append_const'`` action is typically
useful when multiple arguments need to store constants to the same list. For
example::
@ -801,8 +801,8 @@ how the command-line arguments should be handled. The supplied actions are:
>>> parser.parse_args('--str --int'.split())
Namespace(types=[<class 'str'>, <class 'int'>])
* ``'extend'`` - This stores a list and appends each item from the multi-value
argument list to it.
* ``'extend'`` - This appends each item from a multi-value
argument to a list.
The ``'extend'`` action is typically used with the nargs_ keyword argument
value ``'+'`` or ``'*'``.
Note that when nargs_ is ``None`` (the default) or ``'?'``, each
@ -816,7 +816,7 @@ how the command-line arguments should be handled. The supplied actions are:
.. versionadded:: 3.8
* ``'count'`` - This counts the number of times a keyword argument occurs. For
* ``'count'`` - This counts the number of times an argument occurs. For
example, this is useful for increasing verbosity levels::
>>> parser = argparse.ArgumentParser()