Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Sep 23, 2024
Merged

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

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
af0d357
add mention of stderr for clarity to exit()
savannahostrowski Sep 11, 2024
4826792
update error() for better grammar and consistency
savannahostrowski Sep 11, 2024
040e1a2
grammar update
savannahostrowski Sep 11, 2024
90000f2
add docstring to exit as well
savannahostrowski Sep 19, 2024
6718506
Merge branch 'main' into gh-79714
savannahostrowski Sep 22, 2024
2c8112c
Address PR comments
savannahostrowski Sep 22, 2024
3e4cf5c
update to stderr
savannahostrowski Sep 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down Expand Up @@ -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):
Expand All @@ -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
Expand Down
Loading