Skip to content

Document how to discourage API #29078

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
merged 1 commit into from
Nov 5, 2024
Merged

Document how to discourage API #29078

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions doc/devel/api_changes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,3 +239,20 @@ What's new notes
.. include:: ../users/next_whats_new/README.rst
:start-after: whats-new-guide-start
:end-before: whats-new-guide-end

Discourage API
--------------

We have API that we do not recommend anymore for new code, but that cannot be
deprecated because its removal would be breaking backward-compatibility and too
disruptive. In such a case we can formally discourage API. This can cover
specific parameters, call patterns, whole methods etc.

To do so, add a note to the docstring ::

.. admonition:: Discouraged

[description and suggested alternative]

You find several examples for good descriptions if you search the codebase for
``.. admonition:: Discouraged``.