Skip to content

Commit 7bd59d1

Browse files
Document the soft-deprecated directive (#1787)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent 76bb6bb commit 7bd59d1

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

documentation/markup.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1144,6 +1144,19 @@ units as well as normal text:
11441144

11451145
.. deprecated-removed:: next 4.0
11461146

1147+
.. describe:: soft-deprecated
1148+
1149+
Indicates the version from which the described feature is :term:`soft deprecated`.
1150+
1151+
There is one required argument: the version from which the feature is soft
1152+
deprecated.
1153+
Use the word ``next`` to indicate the API will be first soft deprecated in
1154+
the upcoming release.
1155+
1156+
Example::
1157+
1158+
.. soft-deprecated:: next
1159+
11471160
.. describe:: impl-detail
11481161

11491162
This directive is used to mark CPython-specific information. Use either with

0 commit comments

Comments
 (0)