Raymond Hettinger <raymond.hettin...@gmail.com> added the comment:

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.

----------

_______________________________________
Python tracker <rep...@bugs.python.org>
<https://bugs.python.org/issue9694>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to