Skip to content

Commit

Permalink
PEP 257: Drop recommendation of extra blank line at end of docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
Guido van Rossum committed Feb 28, 2014
1 parent eba9b93 commit ab85e78
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions pep-0257.txt
Original file line number Diff line number Diff line change
Expand Up @@ -201,15 +201,14 @@ to list each argument on a separate line. For example::
Keyword arguments:
real -- the real part (default 0.0)
imag -- the imaginary part (default 0.0)

"""
if imag == 0.0 and real == 0.0: return complex_zero
if imag == 0.0 and real == 0.0:
return complex_zero
...

The BDFL [3]_ recommends inserting a blank line between the last
paragraph in a multi-line docstring and its closing quotes, placing
the closing quotes on a line by themselves. This way, Emacs'
``fill-paragraph`` command can be used on it.
Unless the entire docstring fits on a line, place the closing quotes
on a line by themselves. This way, Emacs' ``fill-paragraph`` command
can be used on it.


Handling Docstring Indentation
Expand Down

0 comments on commit ab85e78

Please sign in to comment.