IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Describe the "deprecated" directive.

Browse Source
This commit is contained in:
Georg Brandl 2010-07-29 09:27:46 +02:00
parent 13017eecc8
commit cb26c78079
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/markup/para.rst
View File

@ -42,15 +42,25 @@ units as well as normal text:
Example:: Example::
.. versionadded:: 2.5 .. versionadded:: 2.5
The `spam` parameter. The *spam* parameter.
Note that there must be no blank line between the directive head and the Note that there must be no blank line between the directive head and the
explanation; this is to make these blocks visually continuous in the markup. explanation; this is to make these blocks visually continuous in the markup.
.. rst:directive:: .. versionchanged:: version .. rst:directive:: .. versionchanged:: version
Similar to :rst:dir:`versionadded`, but describes when and what changed in the named Similar to :rst:dir:`versionadded`, but describes when and what changed in
feature in some way (new parameters, changed side effects, etc.). the named feature in some way (new parameters, changed side effects, etc.).
.. rst:directive:: .. deprecated:: vesion
Similar to :rst:dir:`versionchanged`, but describes when the feature was
deprecated. An explanation can also be given, for example to inform the
reader what should be used instead. Example::
.. deprecated:: 3.1
Use :func:`spam` instead.
-------------- --------------