Skip to content

Conversation

@Krishna-web-hub
Copy link
Contributor

@Krishna-web-hub Krishna-web-hub commented Oct 25, 2025

gh-84116: Doc: update the argparse documentation to clearly define the help and aliases parameters for add_parser() and added the required news file for this change.

Doc/library/argparse.rst

Replaced the vague, single-sentence description of _SubParsersAction.add_parser with a formal .. method:: directive.

This new directive explicitly lists help and aliases as parameters, along with descriptions of what they do.

Removed the old, redundant paragraphs about help (which was in parentheses) and aliases (which was a "Furthermore..." note) from later in the document. This centralizes all the information in one logical place.

Misc/NEWS.d/next/Library/...

Added the required "blurb" file to log this documentation fix.


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

@StanFromIreland StanFromIreland changed the title Doc fix 84116Docs: Document help and aliases for argparse.add_parser() (gh-84116) #84116 gh-84116: Docs: Document help and aliases for argparse.add_parser() Oct 25, 2025
Copy link
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

There seem to be two different things mixed in this PR, please split it.

@Krishna-web-hub
Copy link
Contributor Author

Hi @picnixz , @savannahostrowski I have done the requested change please review it again.

@Krishna-web-hub
Copy link
Contributor Author

@picnixz , @savannahostrowski i want to know what i will be doing for the Sub-command please enlighten me such that i can do the final changes.

@picnixz
Copy link
Member

picnixz commented Jan 13, 2026

Keep your changes for that.

@Krishna-web-hub
Copy link
Contributor Author

image Hello @picnixz , do you want it like this or something else. Please confirm me so that i can work in that direction.

@Krishna-web-hub
Copy link
Contributor Author

Please @picnixz , give me final instruction to fix this documentation issue

@@ -0,0 +1,3 @@
Document ``help`` and ``aliases`` parameters for
Copy link
Member

Choose a reason for hiding this comment

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

Please. Delete. This. File.

@@ -0,0 +1,3 @@
Document ``help`` and ``aliases`` parameters for
Copy link
Member

Choose a reason for hiding this comment

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

Please. Delete. This. File.

@picnixz
Copy link
Member

picnixz commented Jan 16, 2026

Please @picnixz , give me final instruction to fix this documentation issue

Next time, please be patient. I do not have enough time to review PRs especially when my feedback is not properly addressed.

@Krishna-web-hub
Copy link
Contributor Author

Krishna-web-hub commented Jan 16, 2026

Thanks @picnixz , for your effort for correcting me, for the mistake i am making. And i am very sorry for being impatient. I will keep it in my mind. And i was just being confused as it is sort of new for me, but i never want to disrespect you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting changes docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

5 participants