Usually users want exactly what is printed by the
$ foo --help
--xxx do xxx
But sometimes it is nice to have a few more details
about each option.
Eg, compare the "OPTIONS" section of the "make(1)"
manpage with "make
$ foo --help-long-option-descriptions # or maybe
--xxx do xxx. This has the side-effect of
turning on yyy. You
may want to use this when ...
An option like "--help-long-option-descriptions" would
provide a means
to see long descriptions for each option when desired.
This does not
even need to be a user-visible option (SUPPRESS_HELP),
desirable for a tool such as help2man that could take
advantage of it
by using this verbose output for use in the generated
help2man already has support for such an option:
Then OptionParser.add_option could have an additional
"help_extended" that contains the additional option info.
help_extended='This has the
side-effect of turning...',
Log in to post a comment.