Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit baa25f3

Browse filesBrowse files
authored
Merge pull request #29303 from timhoffm/doc-discouraged
DOC: Enhance documentation on discouraged API
2 parents a23ef5a + 399a473 commit baa25f3
Copy full SHA for baa25f3

File tree

Expand file treeCollapse file tree

1 file changed

+5
-0
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+5
-0
lines changed

‎doc/devel/api_changes.rst

Copy file name to clipboardExpand all lines: doc/devel/api_changes.rst
+5Lines 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 the API overview like this
262+
263+
[*Discouraged*] Return the XAxis instance.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.