Skip to content

Commit

Permalink
bpo-17050: Remove documentation on argparse.REMAINDER (GH-18661)
Browse files Browse the repository at this point in the history
Closes [Issue 17050]() by removing argparse.REMAINDER from the documentation, as discussed on the issue.

Automerge-Triggered-By: @rhettinger
  • Loading branch information
corollari authored May 24, 2020
1 parent 3436f5f commit 59f5022
Showing 1 changed file with 0 additions and 13 deletions.
13 changes: 0 additions & 13 deletions Doc/library/argparse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -961,19 +961,6 @@ values are:
usage: PROG [-h] foo [foo ...]
PROG: error: the following arguments are required: foo

.. _`argparse.REMAINDER`:

* ``argparse.REMAINDER``. All the remaining command-line arguments are gathered
into a list. This is commonly useful for command line utilities that dispatch
to other command line utilities::

>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo')
>>> parser.add_argument('command')
>>> parser.add_argument('args', nargs=argparse.REMAINDER)
>>> print(parser.parse_args('--foo B cmd --arg1 XX ZZ'.split()))
Namespace(args=['--arg1', 'XX', 'ZZ'], command='cmd', foo='B')

If the ``nargs`` keyword argument is not provided, the number of arguments consumed
is determined by the action_. Generally this means a single command-line argument
will be consumed and a single item (not a list) will be produced.
Expand Down

0 comments on commit 59f5022

Please sign in to comment.