[Numpy-discussion] Howto document constants?

Pierre GM pgmdevlist@gmail....
Fri Nov 13 21:30:23 CST 2009


On Nov 13, 2009, at 9:54 PM, Charles R Harris wrote:

> Hi All,
> 
> The documentation documentation says to document constants like functions. So if a module defines a constant is it documented like so:
> 
> myconstant = 1
> """Blah and blah"""
> 
> That doesn't seem quite right, but what is the proper method?

Why wouldn't you document the constant in the docstring of the module where it's defined ? 
Personally, I used ..data to describe the constants in numpy.ma
http://docs.scipy.org/doc/numpy/_sources/reference/maskedarray.baseclass.txt




More information about the NumPy-Discussion mailing list