[openstack-dev] [opinion-wanted] Clients man pages
Thierry Carrez
thierry at openstack.org
Thu May 23 07:58:47 UTC 2013
Jakub Ruzicka wrote:
> On 22.5.2013 13:32, Thierry Carrez wrote:
>> There is value in keeping the man page details together with the code
>> though, as it's easier to keep the two in sync. I agree that the "help"
>> output is not appropriate, but maybe there is still a way to generate
>> man page content from data that is stored in the code together with
>> options ?
>
> Although that is certainly possible (I.E. additional utils.arg kwarg for
> options and new decorator for command verbose description), question is
> if this will result in a good manpage. See Sean's mail up the thread on
> this topic.
I think Sean makes a great point... hopefully we'll do a good job at
keeping the two in sync.
--
Thierry Carrez (ttx)
Release Manager, OpenStack
More information about the OpenStack-dev
mailing list