Re: meeting docstring standards

[Frankie]

On Wed, 2013-10-16 at 11:06 +0200, Miroslav Suchý wrote:
>  On 10/14/2013 06:31 PM, Frankie Onuonga wrote:
>  > Hi,
>  >
>  > Trust all is well.
>  >
>  > Kindly confirm if this patch is ok.
>  
>  Unfortunately it is not ok.
>  
>  Please see:
>  http://www.python.org/dev/peps/pep-0257/
>  
>  Especially:
>  String literals occurring immediately after a simple assignment at the top level of a
> module, class, or __init__ method 
>  are called "attribute docstrings". 
ok. Makes sense.
>  
>  Having docstrings in middle of code is nonsense, it is not docstring. There should be
> just plain comments.
>  And honestly commenting every import is overkill. 
I only thought it will make
building the documentation easier and that
is why I did that. Point driven home though.
>  
>  Additionally docstring should be indented to same level as code (line 45 of your patch).
Ok.
>  
>