summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYaOzI <bingyao.liu@gmail.com>2019-08-02 12:49:48 +0800
committerJoel Nothman <joel.nothman@gmail.com>2019-08-02 14:49:48 +1000
commitb031883df488c63320f58273a9e5fa94c8c40444 (patch)
tree4f14f17714f5ffe5cc8cfea84eff00e0e147160b
parentb45eb2b4725ffd536d77fb6995983df4775eefb9 (diff)
downloadnumpydoc-b031883df488c63320f58273a9e5fa94c8c40444.tar.gz
DOC: Add description for blank lines after the docstring. (#229)
-rw-r--r--doc/example.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/example.py b/doc/example.py
index e8e6e5f..4ff07c8 100644
--- 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