What's "the standard" for code docs?

Diez B. Roggisch deets at nospam.web.de
Wed Feb 20 09:12:38 CET 2008


> Are people really writing pure HTML snippets in docstrings to document
> each module/class/method?  For anything other than a toy project?
> 
> One of the main reasons I'm considering moving to epydoc + reST is
> precisely because it's very un-HTML.
> 
> Mind you I want to be able to produce HTML format docs from the
> source, but I don't want to actually *put* HTML anywhere near my
> precious sources.

In the Java-world it *is* pure HTML snipplets... but no, not in python.

Diez



More information about the Python-list mailing list