[SciPy-dev] Documenting Warnings

Gael Varoquaux gael.varoquaux@normalesup....
Fri Jun 26 17:23:40 CDT 2009


On Fri, Jun 26, 2009 at 03:21:52PM -0700, David Goldsmith wrote:

> Personally, I think under Notes - with suitable emphasis, e.g., bracketed w/ double *'s, i.e., **Warning:** - would suffice.  However, if it did exist in the standard and was removed, perhaps a summary of why could be added to the FAQ.

I would say: under Notes, using sphinx standard:

.. warning::

    ...

But I haven't check it works with our rendering pipeline.

Gaël


More information about the Scipy-dev mailing list