cpython icon indicating copy to clipboard operation
cpython copied to clipboard

gh-84116: Docs: Document help and aliases for argparse.add_parser()

Open Krishna-web-hub opened this issue 2 months ago • 13 comments

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/

Krishna-web-hub avatar Oct 25 '25 09:10 Krishna-web-hub

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.

bedevere-app[bot] avatar Oct 27 '25 03:10 bedevere-app[bot]

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.

bedevere-app[bot] avatar Dec 08 '25 22:12 bedevere-app[bot]

I have made the requested changes; please review again.

Krishna-web-hub avatar Dec 09 '25 17:12 Krishna-web-hub

Thanks for making the requested changes!

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

bedevere-app[bot] avatar Dec 09 '25 17:12 bedevere-app[bot]

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!

bedevere-app[bot] avatar Dec 09 '25 19:12 bedevere-app[bot]

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

Krishna-web-hub avatar Dec 11 '25 18:12 Krishna-web-hub

Thanks for making the requested changes!

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

bedevere-app[bot] avatar Dec 11 '25 18:12 bedevere-app[bot]

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

Krishna-web-hub avatar Dec 24 '25 12:12 Krishna-web-hub

Apologies for the confusion @savannahostrowski @picnixz. ​I realized that my local commits were not successfully pushed when I posted my last message. I have just pushed the correct changes now, and the checks have passed. The PR is ready for review again.

Krishna-web-hub avatar Dec 28 '25 06:12 Krishna-web-hub

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.

bedevere-app[bot] avatar Dec 28 '25 17:12 bedevere-app[bot]