Re: [openstack-dev] docstring standard?

2015-02-10 Thread Jeremy Stanley
On 2015-02-10 11:57:18 -0800 (-0800), Min Pae wrote: > I think most people would agree documentation is a good thing, and > consistency is generally a good thing…  is there an accepted > standard on layout and minimum required fields? [...] Across OpenStack projects it probably varies a bit. For P

Re: [openstack-dev] docstring standard?

2015-02-10 Thread Brian Curtin
On Tue, Feb 10, 2015 at 1:57 PM, Min Pae wrote: > I think most people would agree documentation is a good thing, and > consistency is generally a good thing… is there an accepted standard on > layout and minimum required fields? > > If not, should there be? > > For example > > - Heading (short de

[openstack-dev] docstring standard?

2015-02-10 Thread Min Pae
I think most people would agree documentation is a good thing, and consistency is generally a good thing… is there an accepted standard on layout and minimum required fields? If not, should there be? For example - Heading (short description) - Description - Inputs - Input name + description