Message383399
Based on the attached survey of practices, I propose a minimal edit to the help display. Instead of "optional arguments:", we say "the options are as follows:".
The use of the word "option" is dominant is in the CLI world, followed by "action" and "switch". The noun form "option" doesn't seem to cause the same confusion that arises in the adjective form "optional arguments" which strongly implies "not required".
For the documentation, I suggest adding a sentence or two in the introduction to explain the terminology used throughout the rest of the argparse docs. |
|
Date |
User |
Action |
Args |
2020-12-19 20:08:57 | rhettinger | set | recipients:
+ rhettinger, terry.reedy, bethard, eric.smith, eric.araujo, r.david.murray, docs@python, benschmaus, tshepang, martin.panter, paul.j3, markgrandi, mburger, Martin.d'Anjou, Oliver.Smith, rhartkopf, Albert White, tonygaetani, shaharg, maggyero, Jacktose, kkarbowiak |
2020-12-19 20:08:57 | rhettinger | set | messageid: <1608408537.8.0.721378977862.issue9694@roundup.psfhosted.org> |
2020-12-19 20:08:57 | rhettinger | link | issue9694 messages |
2020-12-19 20:08:57 | rhettinger | create | |
|