What should Python apps do when asked to show help?

Marko Rauhamaa marko at pacujo.net
Thu Apr 28 14:31:50 EDT 2016


Grant Edwards <grant.b.edwards at gmail.com>:

> On 2016-04-28, Random832 <random832 at fastmail.com> wrote:
>> One disadvantage is that you have to compose two forms of
>> documentation.
>
> Only if you want two forms of documentation.
>
> If you add an option to run the help info through a pager, I don't see
> how that requires you to compose two forms for documentation. If you
> want both plaintext and video help, then yes you'll have to prepare
> two forms of documentation.

I wouldn't want --help to output a reference manual.

Consider GNU tar:

  tar --help   ==>   a list of options
  man tar      ==>   a description of the command and the options
  info tar     ==>   a user manual


Marko



More information about the Python-list mailing list