Make PEP 8 follow PEP 257 on docstring endings.

This commit is contained in:
Guido van Rossum 2014-03-02 09:29:33 -08:00
parent ae9ed08aa0
commit 94af0e93e6
1 changed files with 2 additions and 2 deletions

View File

@ -545,14 +545,14 @@ Conventions for writing good documentation strings
- 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.