https://github.com/python/cpython/commit/a4251411a97304ab001721c6231d86ddf4eac3f0
commit: a4251411a97304ab001721c6231d86ddf4eac3f0
branch: main
author: Savannah Bailey <[email protected]>
committer: savannahostrowski <[email protected]>
date: 2025-05-29T20:34:34-07:00
summary:
GH-106235: Clarify `parse_known_args` documentation by removing "remaining"
(#126921)
files:
M Doc/library/argparse.rst
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 29396c7a0366a1..17f126cc065a82 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -2122,12 +2122,15 @@ Partial parsing
.. method:: ArgumentParser.parse_known_args(args=None, namespace=None)
- Sometimes a script may only parse a few of the command-line arguments,
passing
- the remaining arguments on to another script or program. In these cases, the
- :meth:`~ArgumentParser.parse_known_args` method can be useful. It works
much like
- :meth:`~ArgumentParser.parse_args` except that it does not produce an error
when
- extra arguments are present. Instead, it returns a two item tuple
containing
- the populated namespace and the list of remaining argument strings.
+ Sometimes a script only needs to handle a specific set of command-line
+ arguments, leaving any unrecognized arguments for another script or program.
+ In these cases, the :meth:`~ArgumentParser.parse_known_args` method can be
+ useful.
+
+ This method works similarly to :meth:`~ArgumentParser.parse_args`, but it
does
+ not raise an error for extra, unrecognized arguments. Instead, it parses the
+ known arguments and returns a two item tuple that contains the populated
+ namespace and the list of any unrecognized arguments.
::
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
