From 35e98d55db2a82e23e9610e3638eb43be78b9d53 Mon Sep 17 00:00:00 2001 From: "Kevin L. Mitchell" Date: Thu, 5 Jan 2012 10:21:57 -0600 Subject: 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 --- HACKING.rst | 5 +---- 1 file changed, 1 insertion(+), 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 - """ -- cgit