[SciPy-dev] Documenting classes

Pearu Peterson pearu@cens.ioc...
Mon Jun 16 14:27:19 CDT 2008


Hi,

There is a numpy ticket for a similar issue:

  http://projects.scipy.org/scipy/numpy/ticket/795

Pearu

On Mon, June 16, 2008 10:18 pm, Robert Kern wrote:
> On Mon, Jun 16, 2008 at 12:51, Pierre GM <pgmdevlist@gmail.com> wrote:
>> All,
>> Is there some kind of official template for the documentation of
>> numpy-related
>> classes ?
>
> Not per se, but most of the general outline of the function template
> applies. Ignore Returns. I think I like having the __init__
> constructor Parameters in the class docstring, but I will defer to
> Stéfan's proclamation.
>
>> In particular, what is the syntax for documenting special
>> attributes/properties ?
>
> I recommend adding a section like Parameters.
>
>   Attributes
>   ----------
>   x : float
>       The X coordinate.
>   y : float
>       The Y coordinate.
>
> --
> 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@scipy.org
> http://projects.scipy.org/mailman/listinfo/scipy-dev
>




More information about the Scipy-dev mailing list