[Numpy-discussion] Howto document constants?

Ralf Gommers ralf.gommers@googlemail....
Sat Nov 14 04:10:44 CST 2009


On Sat, Nov 14, 2009 at 3:54 AM, Charles R Harris <charlesr.harris@gmail.com
> wrote:

>
> Also, do we have a way to document static class methods? Class attributes?
>
> Class attributes can be documented in the class docstring as described
here:
http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines#documenting-classes.
If you need a long docstring you could maybe make it a property, which can
have its own docstring.

For static class methods do you mean methods defined with @classmethod or
@staticmethod? I thought they could have their own docstring. Or is the
problem you have static methods defined from C and you can not use
add_newdoc?

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/numpy-discussion/attachments/20091114/9f0bec7a/attachment.html 


More information about the NumPy-Discussion mailing list