Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 8a198b2

Browse files
timhoffmtimhoffm
committed
DOC: Enhance documentation on discouraged API
The added recommendation is already in use in our codebase. Enhances #29078. Closes #19017.
1 parent 35d470a commit 8a198b2

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

‎doc/devel/api_changes.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,3 +256,8 @@ To do so, add a note to the docstring ::
256256

257257
You find several examples for good descriptions if you search the codebase for
258258
``.. admonition:: Discouraged``.
259+
260+
Additionally, if a whole function is discouraged, prefix the summary line with
261+
``[*Discouraged*]`` so that it renders in API overview like this
262+
263+
[*Discouraged*] Return the XAxis instance.

0 commit comments

Comments
 (0)