[SciPy-dev] Documenting data attributes
Thu Jun 25 23:45:45 CDT 2009
On Thu, Jun 25, 2009 at 4:55 PM, Robert Kern <email@example.com> wrote:
> On Thu, Jun 25, 2009 at 15:49, David Goldsmith<firstname.lastname@example.org>
> > 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.
Robert, that docstring references Numerical Recipes in C++, is that okay? Is
it just Numerical Recipes in C that has license issues or the whole series?
> 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
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the Scipy-dev