Skip to content

DOC: Enhance documentation on discouraged API #29303

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 2 commits into from
Dec 13, 2024
Merged

DOC: Enhance documentation on discouraged API #29303

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a198b2
DOC: Enhance documentation on discouraged API
timhoffm Dec 13, 2024
399a473
Update doc/devel/api_changes.rst
timhoffm Dec 13, 2024
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
5 changes: 5 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 @@ -256,3 +256,8 @@ To do so, add a note to the docstring ::

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

Additionally, if a whole function is discouraged, prefix the summary line with
``[*Discouraged*]`` so that it renders in the API overview like this

[*Discouraged*] Return the XAxis instance.
Loading