[BangPypers] Python code documentation doubt
Senthil Kumaran
orsenthil at gmail.com
Thu Apr 22 09:28:25 CEST 2010
On Thu, Apr 22, 2010 at 12:29:30PM +0530, JAGANADH G wrote:
>
> I am looking for a guide to learn the technique of writing such kind of code
> document in my module.
>
The Documentation for modules and functions is called 'docstrings'.
PEP: 257 - is the 'immortalized' pep for docstring conventions.
Also look at pep-0007 and pep-0008 for coding standards.
And google for docutils, restructured text, you might get all the
references you want.
On a site note, the one you pointed out seems to be project specific
and not standard docstrings.
--
Senthil
Are you making all this up as you go along?
More information about the BangPypers
mailing list