x/python-ganttclient
Code Issues Proposed changes

fix :returns: and add pep-0257

Browse Source
This commit is contained in:
termie
2011-02-12 13:30:31 -08:00
parent 57b28c1f64
commit c5e7d2bbea
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
HACKING
View File

@@ -57,8 +57,12 @@ Docstrings
parameters and return types use the Sphinx format. After that an extra parameters and return types use the Sphinx format. After that an extra
newline then close the quotations. newline then close the quotations.
When writing the docstring for a class, an extra line should be placed
after the closing quotations. For more in-depth explanations for these
decisions see http://www.python.org/dev/peps/pep-0257/
:param foo: the foo parameter :param foo: the foo parameter
:param bar: the bar parameter :param bar: the bar parameter
:rtype: the return type :returns: description of the return value
""" """