Javadoc style python manual?

Paul Rubin http
Fri Sep 8 16:52:56 EDT 2006


jjl at pobox.com (John J. Lee) writes:
> Why do you expect to get useful docs that way?  The canonical Python
> stdlib docs live in LaTeX files, not in the docstrings.  You may find
> some useful bits and pieces in the docstrings too, or you may not.

Yucch.  From

  http://www.gnu.org/software/emacs/manual/html_node/Bug-Criteria.html

"If the on-line documentation string of a function or variable
disagrees with the manual, one of them must be wrong; that is a bug."

I think that's preferable to Python's approach.



More information about the Python-list mailing list