]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] GH-79714: Add mention of stderr for clarity to ArgumentParser.exit() (GH-12393...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 23 Sep 2024 22:50:24 +0000 (00:50 +0200)
committerGitHub <noreply@github.com>
Mon, 23 Sep 2024 22:50:24 +0000 (15:50 -0700)
GH-79714: Add mention of stderr for clarity to ArgumentParser.exit() (GH-123932)
(cherry picked from commit 5f5c0b9c23238dc0a1fdb764f625ae0cc5604519)

Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
Doc/library/argparse.rst

index aa1341c8d4d4a8f9591eb043154fa43b4e30f1e3..c4e2dbcac2156c0193a8b702e50752a61979734c 100644 (file)
@@ -1455,7 +1455,7 @@ The ``deprecated`` keyword argument of
 specifies if the argument is deprecated and will be removed
 in the future.
 For arguments, if ``deprecated`` is ``True``, then a warning will be
-printed to standard error when the argument is used::
+printed to :data:`sys.stderr` when the argument is used::
 
    >>> import argparse
    >>> parser = argparse.ArgumentParser(prog='snake.py')
@@ -2235,8 +2235,8 @@ Exiting methods
 .. method:: ArgumentParser.exit(status=0, message=None)
 
    This method terminates the program, exiting with the specified *status*
-   and, if given, it prints a *message* before that. The user can override
-   this method to handle these steps differently::
+   and, if given, it prints a *message* to :data:`sys.stderr` before that.
+   The user can override this method to handle these steps differently::
 
     class ErrorCatchingArgumentParser(argparse.ArgumentParser):
         def exit(self, status=0, message=None):
@@ -2246,8 +2246,8 @@ Exiting methods
 
 .. method:: ArgumentParser.error(message)
 
-   This method prints a usage message including the *message* to the
-   standard error and terminates the program with a status code of 2.
+   This method prints a usage message, including the *message*, to
+   :data:`sys.stderr` and terminates the program with a status code of 2.
 
 
 Intermixed parsing