GH-79714: Add mention of stderr for clarity to ArgumentParser.exit() (GH-123932)

This commit is contained in:
Savannah Ostrowski 2024-09-23 02:08:03 -07:00 committed by GitHub
parent 0e89f7abd4
commit 5f5c0b9c23
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions

View 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