[Python-checkins] peps: Make PEP 8 follow PEP 257 on docstring endings.

guido.van.rossum python-checkins at python.org
Sun Mar 2 18:29:37 CET 2014


http://hg.python.org/peps/rev/380301e300a6
changeset:   5395:380301e300a6
user:        Guido van Rossum <guido at dropbox.com>
date:        Sun Mar 02 09:29:33 2014 -0800
summary:
  Make PEP 8 follow PEP 257 on docstring endings.

files:
  pep-0008.txt |  4 ++--
  1 files changed, 2 insertions(+), 2 deletions(-)


diff --git a/pep-0008.txt b/pep-0008.txt
--- a/pep-0008.txt
+++ b/pep-0008.txt
@@ -545,14 +545,14 @@
 
 - PEP 257 describes good docstring conventions.  Note that most
   importantly, the ``"""`` that ends a multiline docstring should be
-  on a line by itself, and preferably preceded by a blank line, e.g.::
+  on a line by itself, e.g.::
 
       """Return a foobang
 
       Optional plotz says to frobnicate the bizbaz first.
       """
 
-- For one liner docstrings, it's okay to keep the closing ``"""`` on
+- For one liner docstrings, please keep the closing ``"""`` on
   the same line.
 
 

-- 
Repository URL: http://hg.python.org/peps


More information about the Python-checkins mailing list