summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2011-11-20 19:05:23 (GMT)
committerRaymond Hettinger <python@rcn.com>2011-11-20 19:05:23 (GMT)
commitf9cddccf8c165f461ace35302187ce32a3c38d7f (patch)
tree9bc7b11059744bf5f5ccdccc1c045fb2ff49179b
parentf6b1d66a3ca060247e03e7b198db8a5a966b836e (diff)
downloadcpython-f9cddccf8c165f461ace35302187ce32a3c38d7f.zip
cpython-f9cddccf8c165f461ace35302187ce32a3c38d7f.tar.gz
cpython-f9cddccf8c165f461ace35302187ce32a3c38d7f.tar.bz2
Issue #25314: store_true and store_false also create appropriate defaults.
-rw-r--r--Doc/library/argparse.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 2877437..785ecbf 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -729,15 +729,17 @@ how the command-line arguments should be handled. The supplied actions are:
>>> parser.parse_args('--foo'.split())
Namespace(foo=42)
-* ``'store_true'`` and ``'store_false'`` - These store the values ``True`` and
- ``False`` respectively. These are special cases of ``'store_const'``. For
- example::
+* ``'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. For example::
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_true')
>>> parser.add_argument('--bar', action='store_false')
+ >>> parser.add_argument('--baz', action='store_false')
>>> parser.parse_args('--foo --bar'.split())
- Namespace(bar=False, foo=True)
+ Namespace(foo=True, bar=False, baz=True)
* ``'append'`` - This stores a list, and appends each argument value to the
list. This is useful to allow an option to be specified multiple times.