[SciPy-dev] Doc-ing classes and data attributes
Robert Kern
robert.kern at gmail.com
Mon Jun 22 17:33:55 EDT 2009
On Mon, Jun 22, 2009 at 16:32, Ralf Gommers<ralf.gommers at googlemail.com> wrote:
>
> On Mon, Jun 22, 2009 at 4:41 PM, <josef.pktd at 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.
--
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