gh-84116: Docs: Document help and aliases for argparse.add_parser() #140574
Conversation
…python into doc-fix-140281
Krishna-web-hub
force-pushed
the
doc-fix-84116
branch
from
57a35b9 to
343648b
Compare
StanFromIreland
changed the title
StanFromIreland
left a comment
StanFromIreland
left a comment
There was a problem hiding this comment.
There seem to be two different things mixed in this PR, please split it.
Krishna-web-hub
force-pushed
the
doc-fix-84116
branch
from
ce36e2d to
10dffc6
Compare
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
There was a problem hiding this comment.
Please be more careful when you move text. You must keep all indications about "versionadded" etc, for each parameter so that users know when a feature was added. In addition, we are now missing the documentation for the general ArgumentParser.add_subparsers. Are you using an LLM for those changes? If so, please stop because this is wasting reviewer's time as there are useless and wrong changes.
In addition, please resolve the conflicts.
|
Before continuing working on this PR, please fix the conflicts. |
|
Hi @picnixz , |
|
If some changes were mentioned in another PR, please merge main into this branch. You need to do it because there are conflicts. And those conflicts must be resolved before merging: 
Once the diff is clean maybe some changes will be correct. But we are still lacking some description that are now gone and that must not be changed. |
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
|
Hi @picnixz , @savannahostrowski I have done the requested change please review it again. |
|
@picnixz , @savannahostrowski i want to know what i will be doing for the |
|
Keep your changes for that. |
| * *title* - title for the sub-parser group in help output; by default | ||
| "subcommands" if description is provided, otherwise uses title for | ||
| positional arguments | ||
| * *title* - title for the sub-parser group in help output; by default "subcommands" if description is provided, otherwise uses title for positional arguments |
There was a problem hiding this comment.
Ok I don't why you're trying to change this. Why are changing this part of the document? I feel my reviews are just being ignored.
| .. method:: _SubParsersAction.add_parser(name, *, help=None, aliases=None, | ||
| deprecated=False, **kwargs) |
There was a problem hiding this comment.
You need to aligned deprecated with name.
| .. versionadded:: 3.13 | ||
| Added the *deprecated* parameter. |
There was a problem hiding this comment.
This was meant to be added after "constructor.". And be careful with the number of blank lines. Don't just ask an LLM to make them. In fact, don't use LLMs for formatting.
5 participants
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/