[openstack-dev] docstring standard?

Jeremy Stanley fungi at yuggoth.org
Tue Feb 10 23:45:30 UTC 2015


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 Python
source code in general there's a lot of great suggestions in PEP 257
and PEP 287:

https://www.python.org/dev/peps/pep-0257/
https://www.python.org/dev/peps/pep-0287/
-- 
Jeremy Stanley



More information about the OpenStack-dev mailing list