We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
2 parents a23ef5a + 399a473 commit baa25f3Copy full SHA for baa25f3
doc/devel/api_changes.rst
@@ -256,3 +256,8 @@ To do so, add a note to the docstring ::
256
257
You find several examples for good descriptions if you search the codebase for
258
``.. admonition:: Discouraged``.
259
+
260
+Additionally, if a whole function is discouraged, prefix the summary line with
261
+``[*Discouraged*]`` so that it renders in the API overview like this
262
263
+ [*Discouraged*] Return the XAxis instance.
0 commit comments