Re: How to document Python code properly for Pydoc

2009-07-23 Thread jorma kala
Thanks very much for your help On Wed, Jul 22, 2009 at 6:43 PM, Lie Ryan wrote: > jorma kala wrote: > > Hi, > > Do you know where I can find the rules for documenting Python code, so > > that automatic document generation with Pydoc makes the most of the > > comments inserted in the code? > > I

Re: How to document Python code properly for Pydoc

2009-07-22 Thread Lie Ryan
jorma kala wrote: > Hi, > Do you know where I can find the rules for documenting Python code, so > that automatic document generation with Pydoc makes the most of the > comments inserted in the code? > I know about documenting class and method through triple quote just > under the class definition.

How to document Python code properly for Pydoc

2009-07-22 Thread jorma kala
Hi, Do you know where I can find the rules for documenting Python code, so that automatic document generation with Pydoc makes the most of the comments inserted in the code? I know about documenting class and method through triple quote just under the class definition. But how do you comment a spec