Standard way of documenting python code ?

[Rony]

John J. Lee wrote on 30 Nov 2003 15:30:28 +0000 in : <87u14lq3fv.fsf at pobox.com>

> Rony <bucodi at ahoo.fr> writes:
> 
> > A question on python source documentation.
> > Does there exist a standard for documenting code ?
> > I've included here an example generated by pydoc of one of my modules.
> > Is this the right way or is it overkill ?
> > Comments are appreciated
> [...]
> 
> http://www.python.org/peps/pep-0008.html
> 
> There are some good guidelines about docstrings in there.
> 
> If you're writing in English, error is spelled "error", not
> "erreur". :-)
> 
> 
> John

Thanks for the link.
Oh BTW 'erreur' of 'error' ? In both cases it won't be wrong , no? ;)


-- 
Rony

  /_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
 /   bucodi at yahoo.fr
/
|    www.bucodi.com - My work
\    www.ifrance/karamusique  -- My hobby
 \_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/