x/python-ganttclient
Code Issues Proposed changes

Update HACKING.rst.

Browse Source 
Removes the requirement for a trailing blank line in multiline
docstrings, just before the closing '"""'.  This blank line is not
needed anymore, as the editors it was recommended for no longer
have the problem that this blank line was working around.

Change-Id: I4e532231f1d99e9f5048cbfcc791a4328fb1e8f5
This commit is contained in:
Kevin L. Mitchell
2012-01-05 10:21:57 -06:00
parent c06a7cab5e
commit 9f31bbfc8f
1 changed files with 1 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
HACKING.rst
View File

@@ -69,9 +69,7 @@ Example::
Then a new paragraph after a newline that explains in more detail any
general information about the function, class or method. Example usages
are also great to have here if it is a complex class for function. After
you have finished your descriptions add an extra newline and close the
quotations.
are also great to have here if it is a complex class for function.
When writing the docstring for a class, an extra line should be placed
after the closing quotations. For more in-depth explanations for these
@@ -85,7 +83,6 @@ Example::
:returns: return_type -- description of the return value
:returns: description of the return value
:raises: AttributeError, KeyError
"""