Isaac Rodriguez wrote:
> Since Python is a very powerful language parsing strings, replacing
> expressions, and processing XML, I was wondering if people documents the
> code using constructs similar to JavaDoc
if you want something very similar to JavaDoc, you can use PythonDoc:
http://effb
Isaac Rodriguez wrote:
> Are there any standarized ways of documenting Python code? When I check the
> __doc__ attribute of the standard modules, the results are kind of plain. Is
> everyone using this style?
See <http://epydoc.sourceforge.net/>. Epydoc has a simple language for
Have a look at Epydoc (http://epydoc.sourceforge.net/), a documentation
system
that generates HTML and PDF docs. Plain text, Javadoc,
ReStructuredText,
and Epytext docstrings are handled gracefully.
ReStructuredText (or a suitable subset of RST) is probably the best
choice IMHO.
SB
--
http://m
Isaac Rodriguez wrote:
> Python is a dynamically typed language, which makes me think of the
> importance of documenting not only the purpose of a particular
function or
> class method, but also what requirements should be met by the
objects passed
> as parameters, what will the function retu
I would say reStructuredText is the preferred format
for documenting Python code. Google is your friend.
Michele Simionato
--
http://mail.python.org/mailman/listinfo/python-list
Hi,
Are there any standarized ways of documenting Python code? When I check the
__doc__ attribute of the standard modules, the results are kind of plain. Is
everyone using this style?
Since Python is a very powerful language parsing strings, replacing
expressions, and processing XML, I was
