<p dir="ltr">Yes on one line, capitalized, period. No on single sentence.</p>
<p dir="ltr">--Guido van Rossum (sent from Android phone)</p>
<div class="gmail_quote">On Jun 27, 2013 8:17 AM, "Larry Hastings" <<a href="mailto:larry@hastings.org">larry@hastings.org</a>> wrote:<br type="attribution"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div text="#000000" bgcolor="#FFFFFF">
<div>On 06/26/2013 08:56 PM, Guido van
Rossum wrote:<br>
</div>
<blockquote type="cite">
<pre>PEP 257 says this on the formatting of multi-line docstrings:
"""
Multi-line docstrings consist of a summary line just like a one-line
docstring, followed by a blank line, followed by a more elaborate
description. The summary line may be used by automatic indexing tools;
it is important that it fits on one line and is separated from the
rest of the docstring by a blank line. [...]
"""
I still like this rule, but it is violated frequently, in the stdlib
and elsewhere. I'd like to urge stdlib contributors and core devs to
heed it -- or explain why you can't.
</pre>
</blockquote>
<br>
Argument Clinic could conceivably enforce this. It could mandate
that the first paragraph of the function docstring contain exactly
one sentence (must end in a period, all embedded periods cannot be
followed by<br>
whitespace). This would make some things nicer; I could
automatically insert the per-parameter docstrings in after the
summary.<br>
<br>
Should it?<br>
<br>
<br>
<i>/arry</i><br>
</div>
<br>_______________________________________________<br>
Python-Dev mailing list<br>
<a href="mailto:Python-Dev@python.org">Python-Dev@python.org</a><br>
<a href="http://mail.python.org/mailman/listinfo/python-dev" target="_blank">http://mail.python.org/mailman/listinfo/python-dev</a><br>
Unsubscribe: <a href="http://mail.python.org/mailman/options/python-dev/guido%40python.org" target="_blank">http://mail.python.org/mailman/options/python-dev/guido%40python.org</a><br>
<br></blockquote></div>