openstack-attic/melange
Code Issues Proposed changes

some updates to HACKING to describe the docstrings

Browse Source
This commit is contained in:
termie 2011-02-02 13:13:10 -08:00
parent 39793c8cf4
commit bf6a393e55
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
HACKING
View File

@ -47,3 +47,18 @@ Human Alphabetical Order Examples
from nova.auth import users
from nova.endpoint import api
from nova.endpoint import cloud
Docstrings
----------
"""Summary of the function, class or method, less than 80 characters.
New paragraph after newline that explains in more detail any general
information about the function, class or method. After this, if defining
parameters and return types use the Sphinx format. After that an extra
newline then close the quotations.
:param foo: the foo parameter
:param bar: the bar parameter
:rtype: the return type
"""