🌐 AI搜索 & 代理 主页
Skip to content

Highlighted .cbook.warn_deprecated() in contributing.rst #17047

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
timhoffm merged 2 commits into from
Apr 7, 2020
Merged

Highlighted .cbook.warn_deprecated() in contributing.rst #17047

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a7c3e3
Highted .cbook.warn_deprecated() in contributing.rst
SidharthBansal Apr 6, 2020
0df93e8
Update doc/devel/contributing.rst
SidharthBansal Apr 7, 2020
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
2 changes: 1 addition & 1 deletion doc/devel/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ prevent unexpected breaking of code that uses Matplotlib.
- If possible, usage of an deprecated API should emit a
`.MatplotlibDeprecationWarning`. There are a number of helper tools for this:

- Use `.cbook.warn_deprecated()` for general deprecation warnings.
- Use ``cbook.warn_deprecated()`` for general deprecation warnings.
- Use the decorator ``@cbook.deprecated`` to deprecate classes, functions,
methods, or properties.
- To warn on changes of the function signature, use the decorators
Expand Down