PEP 8: Add one line docstring example (#1670)
This commit is contained in:
parent
48e95e4767
commit
0511666bde
|
@ -785,7 +785,9 @@ Conventions for writing good documentation strings
|
|||
"""
|
||||
|
||||
- For one liner docstrings, please keep the closing ``"""`` on
|
||||
the same line.
|
||||
the same line::
|
||||
|
||||
"""Return an ex-parrot."""
|
||||
|
||||
|
||||
Naming Conventions
|
||||
|
|
Loading…
Reference in New Issue