https://github.com/python/cpython/commit/cfcd52490d6531f3b0e8ddd4bb2b40fb6baee854
commit: cfcd52490d6531f3b0e8ddd4bb2b40fb6baee854
branch: main
author: Moshe Kaplan <[email protected]>
committer: gpshead <[email protected]>
date: 2025-11-28T23:23:34-08:00
summary:
GH-141963: Clarify argparse documentation (GH-141964)
Clarify argparse documentation
Tightens the phrasing for several argparse actions.
files:
M Doc/library/argparse.rst
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 2a39f248651936..71c4f094886546 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -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()
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
