Skip to content
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

Jump to bottom

MEP22 warnings #5017

Merged
merged 2 commits into from
Sep 3, 2015
Merged

MEP22 warnings #5017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d872348
warnings
OceanWolf Sep 3, 2015
f5e43c1
Whats new
OceanWolf Sep 3, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/users/whats_new/rcparams.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
6 changes: 4 additions & 2 deletions doc/users/whats_new/toolmanager.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions lib/matplotlib/backend_managers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 3 additions & 0 deletions lib/matplotlib/backend_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down