Skip to content
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.

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

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

savannahostrowski
Copy link
Member

@savannahostrowski savannahostrowski commented Sep 11, 2024

This PR adds a tiny clarification about how ArgumentParser.exit() prints to stderr.


📚 Documentation preview 📚: https://cpython-previews--123932.org.readthedocs.build/

@savannahostrowski savannahostrowski added skip news 3.14 new features, bugs and security fixes labels Sep 11, 2024
@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir labels Sep 11, 2024
@@ -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 stderr
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated this to be consistent with the addition above. I'm happy to also write "standard error" if that's the agreed-upon convention. It seemed like there was mixed usage across the docs.

@savannahostrowski savannahostrowski changed the title GH-79714: add mention of stderr for clarity to exit() GH-79714: add mention of stderr for clarity to ArgumentParser.exit() Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.14 new features, bugs and security fixes awaiting review docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant