[SciPy-user] Docstring standards for NumPy and SciPy

Glen W. Mabey Glen.Mabey at swri.org
Wed Jan 10 08:51:42 CST 2007


On Wed, Jan 10, 2007 at 07:43:28AM -0700, Travis Oliphant wrote:
> 
> There was a lively discussion on the SciPy List before Christmas 
> regarding establishing a standard for documentation strings for NumPy / 
> SciPy.
> 
> I am very interested in establishing such a standard.

<snip>

> See also:
>    * func1 -- any notes about the relationship
>    * func2 --
>    * func3 --
>    (or this can be a comma separated list)
>    func1, func2, func3

Can I just say that the "See also" feature is often a tedious field to
maintain, but it is *extremely* useful when trying to explore the
available features and functionality of numpy/scipy.

Glen



More information about the SciPy-user mailing list