[SciPy-dev] Documenting classes

Stéfan van der Walt stefan@sun.ac...
Tue Jun 17 16:36:06 CDT 2008


2008/6/17 Robert Kern <robert.kern@gmail.com>:
>> 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.
>
> Even then, there is a difference between a public API and the
> interesting subset. For example, memmap subclasses ndarray. The
> interesting additional method is flush() which should be mentioned in
> the docstring because a user would never discover it without reading
> the source.

That is a very good point;  I'll add a Methods section.  I don't think
we'll need it too frequently, but it is good to cover all bases.

Regards
Stéfan


More information about the Scipy-dev mailing list