[Python-ideas] PEP-257: drop recommendation for extra line at end of multi-line docstring

[Guido van Rossum]

I haven't followed this recommendation for years. :-) Good riddance!

(However, the one about two spaces after a period stands. :-)


On Thu, Feb 27, 2014 at 2:06 PM, Ziad Sawalha <ziad.sawalha at rackspace.com>wrote:

> PEP-257 includes this recommendation:
>
> "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."
>
> I believe emacs no longer has this limitation. "If you do fill-paragraph
> in emacs in Python mode
> within a docstring, emacs already ignores the closing triple-quote.  In
> fact, the most recent version
> of emacs supports several different docstring formatting styles and gives
> you the ability to switch
> between them." - quoting Kevin L. Mitchell who is more familiar with emacs
> than I am.
>
> I'm considering removing that recommendation and updating some of the
> examples in PEP-257,
> but I'd like some thoughts from this group before I submit the patch. Any
> thoughts or references to
> conversations that may have already been had on this topic?
>
> Regards,
> Ziad
> _______________________________________________
> Python-ideas mailing list
> Python-ideas at python.org
> https://mail.python.org/mailman/listinfo/python-ideas
> Code of Conduct: http://python.org/psf/codeofconduct/
>



-- 
--Guido van Rossum (python.org/~guido)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-ideas/attachments/20140227/a1e79597/attachment.html>