mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-23 19:25:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Improving readability of argparse.rst (GH-91751)

Browse source 
Fixed few typos and enhanced few paragraphs for your review and consideration.
Trivial contribution towards continuous improvement, so no issue was raised.

Automerge-Triggered-By: GH:rhettinger
This commit is contained in:
Antonio Andrade 2022-05-01 02:20:10 +04:00 • committed by GitHub
parent 5dcfb916c7
commit 238aa6253b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
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

@ -22,8 +22,8 @@
The :mod:`argparse` module makes it easy to write user-friendly command-line The :mod:`argparse` module makes it easy to write user-friendly command-line
interfaces. The program defines what arguments it requires, and :mod:`argparse` interfaces. The program defines what arguments it requires, and :mod:`argparse`
will figure out how to parse those out of :data:`sys.argv`. The :mod:`argparse` will figure out how to parse those out of :data:`sys.argv`. The :mod:`argparse`
module also automatically generates help and usage messages and issues errors module also automatically generates help and usage messages. The module
when users give the program invalid arguments. will also issue errors when users give the program invalid arguments.
Core Functionality Core Functionality
@ -91,8 +91,8 @@ produces either the sum or the max::
args = parser.parse_args() args = parser.parse_args()
print(args.accumulate(args.integers)) print(args.accumulate(args.integers))
Assuming the Python code above is saved into a file called ``prog.py``, it can Assuming the above Python code is saved into a file called ``prog.py``, it can
be run at the command line and provides useful help messages: be run at the command line and it provides useful help messages:
.. code-block:: shell-session .. code-block:: shell-session
@ -119,7 +119,7 @@ the command-line integers:
$ python prog.py 1 2 3 4 --sum $ python prog.py 1 2 3 4 --sum
10 10
If invalid arguments are passed in, it will issue an error: If invalid arguments are passed in, an error will be displayed:
.. code-block:: shell-session .. code-block:: shell-session
@ -159,7 +159,7 @@ used when :meth:`~ArgumentParser.parse_args` is called. For example::
Later, calling :meth:`~ArgumentParser.parse_args` will return an object with Later, calling :meth:`~ArgumentParser.parse_args` will return an object with
two attributes, ``integers`` and ``accumulate``. The ``integers`` attribute two attributes, ``integers`` and ``accumulate``. The ``integers`` attribute
will be a list of one or more ints, and the ``accumulate`` attribute will be will be a list of one or more integers, and the ``accumulate`` attribute will be
either the :func:`sum` function, if ``--sum`` was specified at the command line, either the :func:`sum` function, if ``--sum`` was specified at the command line,
or the :func:`max` function if it was not. or the :func:`max` function if it was not.
@ -555,7 +555,7 @@ disallowed.
fromfile_prefix_chars fromfile_prefix_chars
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
Sometimes, for example when dealing with a particularly long argument lists, it Sometimes, when dealing with a particularly long argument lists, it
may make sense to keep the list of arguments in a file rather than typing it out may make sense to keep the list of arguments in a file rather than typing it out
at the command line. If the ``fromfile_prefix_chars=`` argument is given to the at the command line. If the ``fromfile_prefix_chars=`` argument is given to the
:class:`ArgumentParser` constructor, then arguments that start with any of the :class:`ArgumentParser` constructor, then arguments that start with any of the
@ -1228,7 +1228,7 @@ Any container can be passed as the *choices* value, so :class:`list` objects,
Use of :class:`enum.Enum` is not recommended because it is difficult to Use of :class:`enum.Enum` is not recommended because it is difficult to
control its appearance in usage, help, and error messages. control its appearance in usage, help, and error messages.
Formatted choices overrides the default *metavar* which is normally derived Formatted choices override the default *metavar* which is normally derived
from *dest*. This is usually what you want because the user never sees the from *dest*. This is usually what you want because the user never sees the
*dest* parameter. If this display isn't desirable (perhaps because there are *dest* parameter. If this display isn't desirable (perhaps because there are
many choices), just specify an explicit metavar_. many choices), just specify an explicit metavar_.