summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAlbert <me@albert.sh>2020-05-24 18:57:40 (GMT)
committerGitHub <noreply@github.com>2020-05-24 18:57:40 (GMT)
commit59f5022b5d3e5fcc60ac61cc256b627decf8ee68 (patch)
treec0af577875e70baf5a32bc018eb58523d200da86 /Doc
parent3436f5f899f272d7164add072beb18eebd46d777 (diff)
downloadcpython-59f5022b5d3e5fcc60ac61cc256b627decf8ee68.zip
cpython-59f5022b5d3e5fcc60ac61cc256b627decf8ee68.tar.gz
cpython-59f5022b5d3e5fcc60ac61cc256b627decf8ee68.tar.bz2
bpo-17050: Remove documentation on argparse.REMAINDER (GH-18661)
Closes [Issue 17050]() by removing argparse.REMAINDER from the documentation, as discussed on the issue. Automerge-Triggered-By: @rhettinger
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/argparse.rst13
1 files changed, 0 insertions, 13 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index f8e3918..5e0096c 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -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.