➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: argparse: help parameter not documented in add_subparsers().add_parser
Type: enhancement Stage:
Components: Documentation Versions: Python 3.9, Python 3.8, Python 3.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Nazime Koussaila Lakehal, docs@python, paul.j3, rahul-kumi, rhettinger
Priority: normal Keywords:

Created on 2020-03-11 16:25 by Nazime Koussaila Lakehal, last changed 2022-04-11 14:59 by admin.

Messages (1)
msg363932 - (view) Author: Nazime Koussaila Lakehal (Nazime Koussaila Lakehal) Date: 2020-03-11 16:25 
The parameter help in the method add_parser of _SubParsersAction (that we obtain with ArgumentParser.add_subparsers()) Is not documented.

In the documentation we can find:
The add_subparsers() method is normally called with no arguments and returns a special action object. This object has a single method, add_parser(), which takes a command name and any ArgumentParser constructor arguments, and returns an ArgumentParser object that can be modified as usual.

I found the parameter by accident and then I checked in the source code, it's unfortunate because the help parameter give really nice output when having sub commands.

the parameter 'aliases' is also not documented.
History
Date User Action Args
2022-04-11 14:59:28adminsetgithub: 84116
2020-03-11 19:07:12rahul-kumisetnosy: + rahul-kumi
2020-03-11 16:41:32xtreaksetnosy: + rhettinger, paul.j3

versions: - Python 2.7, Python 3.5, Python 3.6
2020-03-11 16:25:58Nazime Koussaila Lakehalcreate