DOC: Add description for blank lines after the docstring. (#229)

bingyao · jnothman · commit b031883df488 · 2019-08-02T14:49:48.000+10:00
diff --git a/doc/example.py b/doc/example.py
@@ -119,5 +119,8 @@ def foo(var1, var2, long_var_name='hi'):
     b
 
     """
-
+    # After closing class docstring, there should be one blank line to
+    # separate following codes (according to PEP257).
+    # But for function, method and module, there should be no blank lines
+    # after closing the docstring.
     pass

Original file line number	Diff line number	Diff line change
`@@ -119,5 +119,8 @@ def foo(var1, var2, long_var_name='hi'):`
`119`	`119`	`b`
`120`	`120`
`121`	`121`	`"""`
`122`		`-`
	`122`	`+ # After closing class docstring, there should be one blank line to`
	`123`	`+ # separate following codes (according to PEP257).`
	`124`	`+ # But for function, method and module, there should be no blank lines`
	`125`	`+ # after closing the docstring.`
`123`	`126`	`pass`