<div dir="ltr"><div class="gmail_extra"><div class="gmail_quote">On Mon, Sep 23, 2013 at 12:57 AM, Larry Hastings <span dir="ltr"><<a href="mailto:larry@hastings.org" target="_blank">larry@hastings.org</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div text="#000000" bgcolor="#FFFFFF"><div class="im">
<div>On 09/23/2013 03:44 AM, Guido van
Rossum wrote:<br>
</div>
</div><blockquote type="cite">
<div dir="ltr">
<div class="gmail_extra">
<div class="gmail_quote"><div class="im">On Sun, Sep 22, 2013 at 7:25 PM,
Terry Reedy <span dir="ltr"><<a href="mailto:tjreedy@udel.edu" target="_blank">tjreedy@udel.edu</a>></span>
wrote:<br>
</div><div class="im"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">I am
gradually changing Idle docstrings, though only Idle
developers will ever see them. Writing a 60 char summary
forces a clear understanding of the function.</blockquote>
<div><br>
</div>
</div><div class="im"><div>Glad you like it. I still do, too, but I've given up
hope to convince all core developers to stick to this
style. :-(<br>
</div>
</div></div>
</div>
</div>
</blockquote>
<br>
... Argument Clinic to the rescue? Since the last time this subject
came up, Clinic has started enforcing a summary line in docstrings.
I didn't realize it had to be 60 columns though, should I add that?
Is the entire docstring supposed to be 60 columns max?<br></div></blockquote><div><br></div><div>I think 60 is just a guideline. In stdlib .py source code I want it not to extend beyond the 79th column (see recent PEP 8 argument). For a typical class, where the docstring is indented 4 spaces, that leaves 72 characters for the summary line (including a final period!). For a method it's 68 due to the extra indent.<br>
<br>FWIW I also prefer having the summary line on the same line as the opening """:<br><br></div><div>def foo():<br></div><div> """This is the summary.<br><br></div><div> This is the rest.<br>
"""<br></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div text="#000000" bgcolor="#FFFFFF">
p.s. status update: AC is done enough to be worth considering
checking in. Now I have to finish the PEP and write the
documentation.<br clear="all"></div></blockquote></div><br>-- <br>--Guido van Rossum (<a href="http://python.org/~guido">python.org/~guido</a>)
</div></div>