[Tutor] __doc__ strings for attributes?
Kent Johnson
kent37 at tds.net
Fri Nov 9 14:02:49 CET 2007
Wesley Brooks wrote:
> I do however get a real
> problem when it comes to documenting the expected keywords and running
> into huge doc strings, when I prefer concise documentation.
> Is there an standard way of doing this?
docstrings are the only standard way to document classes and functions.
Here is an example of long docstrings with lots of potential keyword args:
http://matplotlib.sourceforge.net/matplotlib.axes.html
Kent
More information about the Tutor
mailing list