[SciPy-dev] [SciPy-user] Docstring standards for NumPy and SciPy
Travis Oliphant
oliphant at ee.byu.edu
Thu Jan 18 00:44:37 EST 2007
Robert Kern wrote:
> Travis Oliphant wrote:
>
>> After some more lively discussion, here is my latest proposal. We will
>> use reST for the docstrings with specific sections expected as given.
>> The Notes and Examples section are optional but the Examples section is
>> strongly encouraged.
>>
>
> There's another section that we should encourage (since authors tend not to
> document it otherwise):
>
>
>
Good idea. There is a consolidated field named Exceptions that epydoc
recognizes which we could also use.
-Travis
More information about the SciPy-Dev
mailing list