From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Fri, 30 May 2025 20:24:08 +0000 (+0200) Subject: [3.14] GH-106235: Clarify `parse_known_args` documentation by removing "remaining... X-Git-Tag: v3.14.0b3~124 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2912fcc2e4675262bc44b200ceb513f01be311e1;p=thirdparty%2FPython%2Fcpython.git [3.14] GH-106235: Clarify `parse_known_args` documentation by removing "remaining" (GH-126921) (#134913) GH-106235: Clarify `parse_known_args` documentation by removing "remaining" (GH-126921) (cherry picked from commit a4251411a97304ab001721c6231d86ddf4eac3f0) Co-authored-by: Savannah Bailey --- diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index 29396c7a0366..17f126cc065a 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. ::