diff --git a/doc/users/whats_new/rcparams.rst b/doc/users/whats_new/rcparams.rst index 68b37dc29ef7..d97620c86465 100644 --- 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 index 889333e6bace..27c6929eacac 100644 --- 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 index 2af8cb88cc66..e21e12f982e3 100644 --- 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 index 79a9bdc43a57..0b00995241b8 100644 --- 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
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: