[Python-Dev] Best practice for documentation for std lib

[Antoine Pitrou]

On Mon, 23 Sep 2013 08:57:01 +0100
Larry Hastings <larry at hastings.org> wrote:
> On 09/23/2013 03:44 AM, Guido van Rossum wrote:
> > On Sun, Sep 22, 2013 at 7:25 PM, Terry Reedy <tjreedy at udel.edu 
> > <mailto:tjreedy at udel.edu>> wrote:
> >
> >     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.
> >
> >
> > Glad you like it. I still do, too, but I've given up hope to convince 
> > all core developers to stick to this style. :-(
> 
> ... 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?
> 
> 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.

I hope it can make it in for 3.4 :)

cheers

Antoine.