[SciPy-dev] Doc-ing classes and data attributes

Stéfan van der Walt stefan@sun.ac...
Sat Jun 20 01:19:44 CDT 2009


Hi David

2009/6/20 David Goldsmith <d_l_goldsmith@yahoo.com>:
> Hi!  The template http://projects.scipy.org/numpy/browser/trunk/doc/example.py#L37 for documenting things doesn't seem like a very good template for documenting objects, e.g., ufunc, and data (as opposed to method) attributes of objects, e.g., ndarray.dtype.  Are there other templates for these elsewhere?  Thanks!

Have a look at

http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines#docstring-standard

under the section "Documenting Classes".  Is that what you're looking for?

Regards
Stéfan


More information about the Scipy-dev mailing list