<br><br><div class="gmail_quote">On Thu, Jun 3, 2010 at 10:52 PM, Pauli Virtanen <span dir="ltr">&lt;<a href="mailto:pav@iki.fi">pav@iki.fi</a>&gt;</span> wrote:<br><blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
Thu, 03 Jun 2010 22:43:02 +0800, Ralf Gommers wrote:<br>
[clip]<br>
<div class="im">&gt; It should be made as visible as possible in my opinion. A reST warning<br>
&gt; in between summary and extended summary would work. It should clearly<br>
&gt; state in which version it will be removed. Best to keep the text<br>
&gt; identical to the one passed to the deprecate decorator. A reason or<br>
&gt; alternative should be given as well.<br>
&gt;<br>
&gt; .. warning::<br>
&gt;     `myfunc` is deprecated and will be removed in SciPy 0.9. Look at<br>
&gt; `thatfunc` for equivalent functionality.<br>
<br>
</div>Sphinx probably has a special format for deprecations. Best to use that,<br>
I believe.<br>
<br></blockquote><div>Good point. In the Sphinx 0.6.6 docs I can&#39;t find it, but it seems there is indeed a &quot;.. deprecated::&quot; directive, <a href="https://bitbucket.org/birkenfeld/sphinx/issue/92/deprecated-options-not-working-in">https://bitbucket.org/birkenfeld/sphinx/issue/92/deprecated-options-not-working-in</a> <br>
<br>Cheers,<br>Ralf</div></div>