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

Pauli Virtanen pav@iki...
Thu Jun 3 09:52:48 CDT 2010


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.

-- 
Pauli Virtanen



More information about the SciPy-Dev mailing list