From 3a7c3e3d136b9c7103f101ed4415c35980fe041b Mon Sep 17 00:00:00 2001 From: Sidharth Bansal <20972099+SidharthBansal@users.noreply.github.com> Date: Mon, 6 Apr 2020 20:34:12 +0530 Subject: [PATCH 1/2] Highted .cbook.warn_deprecated() in contributing.rst Highted .cbook.warn_deprecated() in contributing.rst --- doc/devel/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst index ab2360393a5e..369f8e9bad03 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -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 From 0df93e81dee1ff03ff0f79a9bbbf3f89ac4bd27c Mon Sep 17 00:00:00 2001 From: Sidharth Bansal <20972099+SidharthBansal@users.noreply.github.com> Date: Tue, 7 Apr 2020 13:57:43 +0530 Subject: [PATCH 2/2] Update doc/devel/contributing.rst Co-Authored-By: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> --- doc/devel/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst index 369f8e9bad03..f80a87f9b735 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -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