IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-10-12 16:32:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Use hyphenated version directives (#13714)

Browse Source 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
Stephen FinucaneandAdam Turner authored and GitHub committed 2025-10-06 00:10:35 +01:00
1 parent 42aa5114ba
commit 44a98961b2
13 files changed
+172 -65
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

doc/usage/restructuredtext/directives.rst
+36 -16
View File
@@ -537,7 +537,8 @@ Describing changes between versions
pair: changes; in version
pair: removed; in version
.. rst:directive:: .. versionadded:: version [brief explanation]
.. rst:directive:: .. version-added:: version [brief explanation]
.. versionadded:: version [brief explanation]
This directive documents the version of the project
which added the described feature.
@@ -551,56 +552,75 @@ Describing changes between versions
There must be no blank line between the directive head and the explanation;
this is to make these blocks visually continuous in the markup.
.. version-changed:: 8.3
The :rst:dir:`versionadded` directive was renamed to :rst:dir:`version-added`.
The previous name is retained as an alias.
Example::
.. versionadded:: 2.5
.. version-added:: 2.5
The *spam* parameter.
.. versionadded:: 2.5
.. version-added:: 2.5
The *spam* parameter.
.. rst:directive:: .. versionchanged:: version [brief explanation]
.. rst:directive:: .. version-changed:: version [brief explanation]
.. versionchanged:: version [brief explanation]
Similar to :rst:dir:`versionadded`, but describes when and what changed in
Similar to :rst:dir:`version-added`, but describes when and what changed in
the named feature in some way (new parameters, changed side effects, etc.).
.. version-changed:: 8.3
The :rst:dir:`versionchanged` directive was renamed to :rst:dir:`version-changed`.
The previous name is retained as an alias.
Example::
.. versionchanged:: 2.8
.. version-changed:: 2.8
The *spam* parameter is now of type *boson*.
.. versionchanged:: 2.8
.. version-changed:: 2.8
The *spam* parameter is now of type *boson*.
.. rst:directive:: .. deprecated:: version [brief explanation]
.. rst:directive:: .. version-deprecated:: version [brief explanation]
.. deprecated:: version [brief explanation]
Similar to :rst:dir:`versionadded`, but describes when the feature was
Similar to :rst:dir:`version-added`, but describes when the feature was
deprecated.
A *brief* explanation can also be given,
for example to tell the reader what to use instead.
.. version-changed:: 8.3
The :rst:dir:`deprecated` directive was renamed to :rst:dir:`version-deprecated`.
The previous name is retained as an alias
Example::
.. deprecated:: 3.1
.. version-deprecated:: 3.1
Use :py:func:`spam` instead.
.. deprecated:: 3.1
.. version-deprecated:: 3.1
Use :py:func:`!spam` instead.
.. rst:directive:: .. versionremoved:: version [brief explanation]
.. rst:directive:: .. version-removed:: version [brief explanation]
.. versionremoved:: version [brief explanation]
Similar to :rst:dir:`versionadded`, but describes when the feature was removed.
Similar to :rst:dir:`version-added`, but describes when the feature was removed.
An explanation may be provided to tell the reader what to use instead,
or why the feature was removed.
.. versionadded:: 7.3
.. version-added:: 7.3
.. version-changed:: 8.3
The :rst:dir:`versionremoved` directive was renamed to :rst:dir:`version-removed`.
The previous name is retained as an alias.
Example::
.. versionremoved:: 4.0
.. version-removed:: 4.0
The :py:func:`spam` function is more flexible, and should be used instead.
.. versionremoved:: 4.0
.. version-removed:: 4.0
The :py:func:`!spam` function is more flexible, and should be used instead.