[SciPy-dev] Doc-ing classes and data attributes

Ralf Gommers ralf.gommers@googlemail....
Mon Jun 22 16:42:26 CDT 2009


On Mon, Jun 22, 2009 at 5:33 PM, Robert Kern <robert.kern@gmail.com> wrote:

> On Mon, Jun 22, 2009 at 16:32, Ralf Gommers<ralf.gommers@googlemail.com>
> wrote:
> >
> > On Mon, Jun 22, 2009 at 4:41 PM, <josef.pktd@gmail.com> wrote:
>
> >> How do we treat other class specific headers?
> >> e.g "Internal Methods" in
> >> http://docs.scipy.org/scipy/docs/scipy.stats.kde.gaussian_kde/
> >
> > Internal Methods is not a part of the documentation standard. Was this
> > discussed on the list last year? I thought the consensus was that methods
> > that are part of the API go under Methods, the rest is not listed in the
> > class docstring.
>
> It's just an incredibly old docstring from long before we bothered to
> standardize anything.
>

Great, thanks. I guess in that case the answer to Josef's question is:
There should be no other class-specific headers, if you come across any,
remove them.

Ralf


> --
> 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://mail.scipy.org/mailman/listinfo/scipy-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20090622/deb965a6/attachment.html 


More information about the Scipy-dev mailing list