Home Original page

[Python-Dev] Reminder: an oft-forgotten rule about docstring formatting (PEP 257)

Guido van Rossum guido at python.org
Thu Jun 27 18:57:30 CEST 2013 
It was never my intention to enforce that everything has a docstring.
Just that if it does, it looks good.

On Thu, Jun 27, 2013 at 9:40 AM, Terry Reedy <tjreedy at udel.edu> wrote:
> On 6/27/2013 11:57 AM, Guido van Rossum wrote:
>>
>> Yes on one line, capitalized, period. No on single sentence.
>
>
> Complete and correct docstrings are somewhat rare in idlelib.
> About half are missing.
> Single lines typically omit the period.
> Multiple lines often omit the blank line after the first.
>
> I will take your reminder as permission to make changes as I review the
> code. I wish there were more good summary lines already.
>
> My understanding is that SubclassTests and test_methods should not have
> docstrings.
>
> --
> Terry Jan Reedy
>
>
> _______________________________________________
> Python-Dev mailing list
> Python-Dev at python.org
> http://mail.python.org/mailman/listinfo/python-dev
> Unsubscribe:
> http://mail.python.org/mailman/options/python-dev/guido%40python.org



-- 
--Guido van Rossum (python.org/~guido)
More information about the Python-Dev mailing list