Skip to content

Document soft-deprecated #1787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StanFromIreland merged 2 commits into from
Apr 19, 2026
Merged

Document soft-deprecated #1787

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a426ab
Document `soft-deprecated`
StanFromIreland Apr 19, 2026
2635a06
Simplify
StanFromIreland Apr 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions documentation/markup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1144,6 +1144,19 @@ units as well as normal text:

.. deprecated-removed:: next 4.0

.. describe:: soft-deprecated

Indicates the version from which the described feature is :term:`soft deprecated`.

There is one required argument: the version from which the feature is soft
deprecated.
Similarly to ``deprecated``, you should use the word ``next`` to indicate
the API will be first soft deprecated in the upcoming release.
Comment thread
StanFromIreland marked this conversation as resolved.
Outdated

Example::

.. soft-deprecated:: next

.. describe:: impl-detail

This directive is used to mark CPython-specific information. Use either with
Expand Down
Loading