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.

@bedevere-app
Copy link

bedevere-app bot commented Dec 8, 2025

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@Krishna-web-hub
Copy link
Contributor Author

I have made the requested changes; please review again.

@bedevere-app
Copy link

bedevere-app bot commented Dec 9, 2025

Thanks for making the requested changes!

@picnixz, @savannahostrowski: please review the changes made to this pull request.

Copy link
Member

@savannahostrowski savannahostrowski left a comment

Choose a reason for hiding this comment

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

Thanks for the updates. A few comments:

  • Can we make add_parser a top-level method directive rather than nesting it under add_subparsers? Right now it's a bit muddled. I think placing it around line 1807 (after the add_subparsers examples) would work well.
  • Related to the last point, the existing sections about add_parser aliases and deprecated further down in the docs are now redundant. We can remove those paragraphs and incorporate the content/examples into the new add_parser documentation.

@bedevere-app
Copy link

bedevere-app bot commented Dec 9, 2025

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

And if you don't make the requested changes, you will be put in the comfy chair!

@Krishna-web-hub
Copy link
Contributor Author

Krishna-web-hub commented Dec 11, 2025

Hi @savannahostrowski ,@picnixz I have made the requested changes; please review again.

@bedevere-app
Copy link

bedevere-app bot commented Dec 11, 2025

Thanks for making the requested changes!

@savannahostrowski, @picnixz: please review the changes made to this pull request.

@Krishna-web-hub
Copy link
Contributor Author

Hi @savannahostrowski , @picnixz i have done all the changes according to your message been waiting for any further changes.

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

Labels

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

5 participants