Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Support multi-figure MultiCursor; prepare improving its signature. #23348

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
Jun 28, 2022

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Jun 25, 2022

Support MultiCursor with Axes spread over different figures.

As a consequence, the first parameter of MultiCursor (canvas) has
become meaningless (requiring the user to pass in
[ax.figure.canvas for ax in axes] seems pointless); just ignore that
argument.

While we're at it, also move some parameters of MultiCursor towards
being keyword-only, to prepare for a hopefully better signature without
the canvas parameter at all.

Closes #23339 (the signature problem remains tracked at #21496).

PR Summary

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • 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).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@anntzer anntzer added this to the v3.6.0 milestone Jun 25, 2022
Support MultiCursor with Axes spread over different figures.

As a consequence, the first parameter of MultiCursor (`canvas`) has
become meaningless (requiring the user to pass in
`[ax.figure.canvas for ax in axes]` seems pointless); just ignore that
argument.

While we're at it, also move some parameters of MultiCursor towards
being keyword-only, to prepare for a hopefully better signature without
the `canvas` parameter at all.
@QuLogic QuLogic merged commit d4548e6 into matplotlib:main Jun 28, 2022
@anntzer anntzer deleted the mc branch June 28, 2022 19:44
@anntzer anntzer mentioned this pull request Jun 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MultiCursor should be able to bind to axes in more than one figure...
3 participants