summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortermie <github@anarkystic.com>2011-02-12 13:30:31 -0800
committertermie <github@anarkystic.com>2011-02-12 13:30:31 -0800
commit556e8a585cf3a344f0ecf386e6195e6e61848071 (patch)
tree285808fbedf922ba00e804ab7c8572835f51f40a
parent4b121d03b27fd2ab3e5a2df0833ff8dfae5dfad3 (diff)
fix :returns: and add pep-0257
-rw-r--r--HACKING6
1 files changed, 5 insertions, 1 deletions
diff --git a/HACKING b/HACKING
index 4e0dfc835..e58d60e58 100644
--- a/HACKING
+++ b/HACKING
@@ -57,8 +57,12 @@ Docstrings
parameters and return types use the Sphinx format. After that an extra
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 bar: the bar parameter
- :rtype: the return type
+ :returns: description of the return value
"""