-
-
Notifications
You must be signed in to change notification settings - Fork 33.3k
Improving readability of argparse.rst #91751
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,8 +22,8 @@ | |
| The :mod:`argparse` module makes it easy to write user-friendly command-line | ||
| 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` | ||
| module also automatically generates help and usage messages and issues errors | ||
| when users give the program invalid arguments. | ||
| module also automatically generates help and usage messages. The module | ||
| will also issue errors when users give the program invalid arguments. | ||
|
|
||
|
|
||
| Core Functionality | ||
|
|
@@ -91,8 +91,8 @@ produces either the sum or the max:: | |
| args = parser.parse_args() | ||
| print(args.accumulate(args.integers)) | ||
|
|
||
| Assuming the Python code above is saved into a file called ``prog.py``, it can | ||
| be run at the command line and provides useful help messages: | ||
| Assuming the above Python code is saved into a file called ``prog.py``, it can | ||
| be run at the command line and it provides useful help messages: | ||
|
|
||
| .. code-block:: shell-session | ||
|
|
||
|
|
@@ -119,7 +119,7 @@ the command-line integers: | |
| $ python prog.py 1 2 3 4 --sum | ||
| 10 | ||
|
|
||
| If invalid arguments are passed in, it will issue an error: | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would keep this unchanged. |
||
| If invalid arguments are passed in, an error will be displayed: | ||
|
|
||
| .. 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 | ||
| 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, | ||
| or the :func:`max` function if it was not. | ||
|
|
||
|
|
@@ -555,7 +555,7 @@ disallowed. | |
| 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 | ||
| 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 | ||
|
|
@@ -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 | ||
| 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 | ||
| *dest* parameter. If this display isn't desirable (perhaps because there are | ||
| many choices), just specify an explicit metavar_. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would keep the original text on both lines here.