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

Terry Reedy tjreedy at udel.edu
Thu Jun 27 20:25:21 CEST 2013


On 6/27/2013 12:57 PM, Guido van Rossum wrote:
> It was never my intention to enforce that everything has a docstring.
> Just that if it does, it looks good.

Ok, I won't add them when a function's name actually makes what it does 
obvious. But when I have to spend at least a few minutes reading the 
body to make sense of it, I will try to add the summary line that I wish 
had been there already.

-- 
Terry Jan Reedy



More information about the Python-Dev mailing list