[SciPy-dev] Documenting Warnings

Ralf Gommers ralf.gommers@googlemail....
Fri Jun 26 15:48:00 CDT 2009


On Fri, Jun 26, 2009 at 3:24 PM, Pierre GM <pgmdevlist@gmail.com> wrote:

> All,
> How do we document a warning, a note that should be displayed
> differently as a note ? Don't we have a "Warnings" entry in the
> docstrings standard ?
> Thx


For longer reST doc files you can use (see for example
http://docs.scipy.org/numpy/docs/numpy-docs/user/index.rst/):

*.. warning::

  Description.

*There is no Warnings heading in the docstring standard. Why can't you put
it either under Notes or under Raises? And special reST markup like the
above is discouraged in docstrings because it looks bad on text terminals.

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20090626/1c15ce73/attachment.html 


More information about the Scipy-dev mailing list