Merge pull request #5017 from OceanWolf/MEP22-warnings

DOC: MEP22 warnings
matplotlib · Sep 3, 2015 · 7c1993d · 7c1993d
2 parents b7ef642 + f5e43c1
commit 7c1993d
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 3 deletions.
diff --git a/doc/users/whats_new/rcparams.rst b/doc/users/whats_new/rcparams.rst
@@ -61,7 +61,9 @@ default), ``'left'``, ``'right'``, ``'bottom'``, ``'top'`` and ``'none'``.
 Added "toolmanager" to "toolbar" possible values
 ````````````````````````````````````````````````
 
-The new value enables the use of ``ToolManager``
+The new value enables the use of ``ToolManager``.  Note at the moment we
+release this for feedback and should get treated as experimental until further
+notice.
 
 
 Added ``axes.labelpad``

diff --git a/doc/users/whats_new/toolmanager.rst b/doc/users/whats_new/toolmanager.rst
@@ -12,8 +12,10 @@ The `Toolbars` are replaced for `ToolContainers` that are just GUI interfaces to
 
 
 .. note::
-	For the moment the `ToolManager` is working only with `GTK3` and `Tk` backends.
-	Make sure you are using one of those.
+    At the moment we release this primarily for feedback purposes and should
+    get treated as experimental until further notice as API changes will occur.
+	For the moment the `ToolManager` works only with the `GTK3` and `Tk` backends.
+	Make sure you use one of those.
 	Port for the rest of the backends is comming soon.
 
 	To activate the `ToolManager` include the following at the top of your file:

diff --git a/lib/matplotlib/backend_managers.py b/lib/matplotlib/backend_managers.py
@@ -57,6 +57,9 @@ class ToolManager(object):
     """
 
     def __init__(self, canvas):
+        warnings.warn('Treat the new Tool classes introduced in v1.5 as ' +
+                       'experimental for now, the API will likely change in ' +
+                       'version 2.1 and perhaps the rcParam as well')
         self.canvas = canvas
 
         self._key_press_handler_id = self.canvas.mpl_connect(

diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -72,6 +72,9 @@ class ToolBase(object):
     """
 
     def __init__(self, toolmanager, name):
+        warnings.warn('Treat the new Tool classes introduced in v1.5 as ' +
+                       'experimental for now, the API will likely change in ' +
+                       'version 2.1, and some tools might change name')
         self._name = name
         self._figure = None
         self.toolmanager = toolmanager