[SciPy-dev] Documenting data attributes

[David Goldsmith]

Well, they're already being documented separately (see, e.g., http://docs.scipy.org/numpy/Milestones/#ndarray-ii-status-63-done-leader-your-name-here, under which several data attributes are listed as needing documentation, independent of the separate listing of numpy.ndarray under http://docs.scipy.org/numpy/Milestones/#ndarray-ii-status-63-done-leader-your-name-here).

DG

--- On Thu, 6/25/09, Robert Kern <robert.kern at gmail.com> wrote:

> From: Robert Kern <robert.kern at gmail.com>
> Subject: Re: [SciPy-dev] Documenting data attributes
> To: "SciPy Developers List" <scipy-dev at scipy.org>
> Date: Thursday, June 25, 2009, 1:55 PM
> On Thu, Jun 25, 2009 at 15:49, David
> Goldsmith<d_l_goldsmith at 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
> _______________________________________________
> Scipy-dev mailing list
> Scipy-dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>