diff options
| author | Kevin L. Mitchell <kevin.mitchell@rackspace.com> | 2012-01-05 10:21:57 -0600 |
|---|---|---|
| committer | Kevin L. Mitchell <kevin.mitchell@rackspace.com> | 2012-01-05 10:21:57 -0600 |
| commit | 35e98d55db2a82e23e9610e3638eb43be78b9d53 (patch) | |
| tree | d862d6eeb900948285d36367e229232cccb5ff28 /HACKING.rst | |
| parent | 8b79dae67ca2686780d3e3b5863d0578264e92a5 (diff) | |
| download | nova-35e98d55db2a82e23e9610e3638eb43be78b9d53.tar.gz nova-35e98d55db2a82e23e9610e3638eb43be78b9d53.tar.xz nova-35e98d55db2a82e23e9610e3638eb43be78b9d53.zip | |
Update HACKING.rst.
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
Diffstat (limited to 'HACKING.rst')
| -rw-r--r-- | HACKING.rst | 5 |
1 files changed, 1 insertions, 4 deletions
diff --git a/HACKING.rst b/HACKING.rst index d9d0f41a6..975498a01 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -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 - """ |