[SciPy-dev] Documenting classes

Robert Kern robert.kern@gmail....
Tue Jun 17 13:22:11 CDT 2008

On Tue, Jun 17, 2008 at 08:10, Stéfan van der Walt <stefan@sun.ac.za> wrote:
> On the other hand,
> methods can be inspected (i.e. TAB-completion in IPython, 'help' or
> 'dir' in the raw shell), so we don't need to list the methods, as
> suggested in the PEP:
> "The docstring for a class should summarize its behavior and list the
> public methods and instance variables."

That said, it can be difficult to pick out which methods are public
and important, and which aren't.

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