[SciPy-dev] Documenting classes

Stéfan van der Walt stefan@sun.ac...
Tue Jun 17 14:59:55 CDT 2008


2008/6/17 Robert Kern <robert.kern@gmail.com>:
> 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.

Maybe it's a good idea to make this implicit in the naming: start the
function name with an underscore if it is not part of the public API.

Regards
Stéfan


More information about the Scipy-dev mailing list