[SciPy-Dev] Warning of deprecation in doc's ?

Ralf Gommers ralf.gommers@googlemail....
Thu Jun 3 10:01:17 CDT 2010


On Thu, Jun 3, 2010 at 10:52 PM, Pauli Virtanen <pav@iki.fi> wrote:

> Thu, 03 Jun 2010 22:43:02 +0800, Ralf Gommers wrote:
> [clip]
> > It should be made as visible as possible in my opinion. A reST warning
> > in between summary and extended summary would work. It should clearly
> > state in which version it will be removed. Best to keep the text
> > identical to the one passed to the deprecate decorator. A reason or
> > alternative should be given as well.
> >
> > .. warning::
> >     `myfunc` is deprecated and will be removed in SciPy 0.9. Look at
> > `thatfunc` for equivalent functionality.
>
> Sphinx probably has a special format for deprecations. Best to use that,
> I believe.
>
> Good point. In the Sphinx 0.6.6 docs I can't find it, but it seems there is
indeed a ".. deprecated::" directive,
https://bitbucket.org/birkenfeld/sphinx/issue/92/deprecated-options-not-working-in

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20100603/0e176300/attachment.html 


More information about the SciPy-Dev mailing list