Skip to content

Commit

Permalink
Update doc/devel/api_changes.rst
Browse files Browse the repository at this point in the history
Co-authored-by: hannah <story645@gmail.com>
  • Loading branch information
timhoffm and story645 authored Dec 13, 2024
1 parent 8a198b2 commit 399a473
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/devel/api_changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,6 @@ 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 API overview like this
``[*Discouraged*]`` so that it renders in the API overview like this

[*Discouraged*] Return the XAxis instance.

0 comments on commit 399a473

Please sign in to comment.