[Numpy-discussion] Unifying numpy, scipy, and matplotlib docstring formats

Alan G Isaac aisaac@american....
Thu Feb 15 13:40:18 CST 2007


On Thu, 15 Feb 2007, Keir Mierle apparently wrote:
>  * Two different header styles
>    The distinction between
>    :Parameters:
>    and
>    Examples
>    --------

These are not two items of the same type.
``:Parameters:`` designates a consolidated field (for 
describing the documented object).  This is not a "section".

Cheers,
Alan Isaac






More information about the Numpy-discussion mailing list