[New-bugs-announce] [issue41980] Argparse documentation is slightly misleading

[Yannick Gingras]

New submission from Yannick Gingras <ygingras at ygingras.net>:

In argparse.rst, while documenting ArgumentParser.add_subparsers, ``prog`` is described on line 1630 as:
  usage information that will be displayed with sub-command help,
  by default the name of the program and any positional arguments 
  before the subparser argument

This is confusing since ``prog`` is actually a very small prefix of the usage message.  Describing this parameter as "name of the program" or event "name of the program with sub-commands" would be more clear.

----------
components: Library (Lib)
messages: 378316
nosy: ygingras
priority: normal
severity: normal
status: open
title: Argparse documentation is slightly misleading
versions: Python 3.9

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue41980>
_______________________________________