I have command-line script blog written using argparse. It supports subcommands. When I check the help doc of a subcommand, e.g., using blog convert -h, it prints the help doc of the subcommand blog convert but doesn't print the description of the subcommand blog convert. A screenshot is attached. It is quite often that I know a command-line application have certain subcommands but I forget exactly what they do. It would be very helpful if blog subcmd -h prints the description of the subcmd so that users do not have to call blog -h again to check exactly what the subcommand does.

Hi!

From your description it is not clear how exactly you create your subcommand.

From my experience, it works. Demo:

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
subparsers = parser.add_subparsers()

# create the parser for the "a" command
parser_a = subparsers.add_parser('a', help='a help', description='test me')
parser_a.add_argument('bar', type=int, help='bar help')

print(parser.parse_args())

Here's the output of python script.py a -h:

usage: ex.py a [-h] bar

test me

positional arguments:
  bar         bar help

options:
  -h, --help  show this help message and exit

Do you have the same setup? Or is there anything else that needs to be fixed?

For me it works as well, tested on 3.7, 3.9 and 3.11 .

Hi, Chuanlong. Would you mind to upload a demo for this question?

Are you expecting the subcommand help to show the 'help' line that the main help shows?

    subparsers.add_parser('a', help='a help')

add_parser takes all of the parameters that ArgumentParser takes, including description and epilog.

I don't think we need to add anything to add_parser.

Closed as the requested feature already exists in argparse.