Hello all,
What is the proper way to document a class in Python? I have written
a few python libraries that I would like to document.
I'm doing a lot of this:
class Foo(object):
"""
This is a class which blah, blah, blah... It's features are blah,
blah, blah...
"""
def addStuff(self):
"""
This method does blah, blah, blah...
"""
I'm going to assume that Python has some "official" tool which can be
used to automatically create documentation for a .py-file (like Java
does), but what do I need to do to support it, and how does it work?
--
Kind Regards,
Jan Danielsson
Te audire no possum. Musa sapientum fixa est in aure.
--
http://mail.python.org/mailman/listinfo/python-list
