[SciPy-dev] Documenting data attributes

Robert Kern robert.kern@gmail....
Thu Jun 25 15:55:46 CDT 2009


On Thu, Jun 25, 2009 at 15:49, David Goldsmith<d_l_goldsmith@yahoo.com> wrote:
>
> Hi!  For the purposes of meeting the documentation standard, are data attributes regarded has "returning" something, i.e., should ndarray.itemsize, for example, have a Returns section?

I would describe them in an Attributes section of the class's
docstring. See MachAr for an example I did some time ago.

  http://docs.scipy.org/numpy/docs/numpy.lib.machar.MachAr/

-- 
Robert Kern

"I have come to believe that the whole world is an enigma, a harmless
enigma that is made terrible by our own mad attempt to interpret it as
though it had an underlying truth."
  -- Umberto Eco


More information about the Scipy-dev mailing list