Skip to content

wx backend API cleanups. #18680

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.

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
merged 1 commit into from
Oct 13, 2020
Merged

wx backend API cleanups. #18680

merged 1 commit into from
Oct 13, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Oct 7, 2020

  • Deprecate origin kwarg to wx gui_repaint(). It's really just a
    slightly obscure way to add a special-path for the (long deprecated)
    wx backend, which can be done more explicitly.

  • Deprecate unused NavigationToolbar2Wx.get_canvas.

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and pydocstyle<4 and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@anntzer anntzer added the GUI: wx label Oct 7, 2020
@anntzer anntzer added this to the v3.4.0 milestone Oct 7, 2020
with no replacement; ``gui_repaint`` now automatically detects the case where
it is used with the wx renderer.

The ``NavigationToolbar2Wx.get_canvas`` method is deprecated; copy its
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the motivation to deprecate this. Getting the canvas seems like a useful action, and type(toolbar.canvas)(frame, -1, figure) is pretty arcane.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That method is not present on any of the other backends NavigationToolbar classes, and I'd rather try to make the NavToolbar API consistent across classes.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would leave out type here, and use the explicit class instead.

with no replacement; ``gui_repaint`` now automatically detects the case where
it is used with the wx renderer.

The ``NavigationToolbar2Wx.get_canvas`` method is deprecated; copy its
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would leave out type here, and use the explicit class instead.

- Deprecate origin kwarg to wx gui_repaint().  It's really just a
  slightly obscure way to add a special-path for the (long deprecated)
  wx backend, which can be done more explicitly.

- Deprecate unused NavigationToolbar2Wx.get_canvas.
@anntzer
Copy link
Contributor Author

anntzer commented Oct 13, 2020

sure

@timhoffm timhoffm merged commit e7601e0 into matplotlib:master Oct 13, 2020
@anntzer anntzer deleted the wxapi branch October 13, 2020 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants