Skip to content

Cleanup RectangleSelector example. #17475

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

Cleanup RectangleSelector example. #17475

merged 1 commit into from
May 22, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented May 21, 2020

  • Don't use "q" or "a" as keys given that they are already mapped to
    "quit" and "all_axes" (even though the latter is deprecated).
  • Document the interactivity directly as the axes title.
  • No need to plot too many things in the axes; they're irrelevant.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

timhoffm
timhoffm approved these changes May 21, 2020
View reviewed changes
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Um, when I toggle to deactivate and then toggle again to activate, I cannot control the existing rectangle, but a new one is drawn on top.

grafik

However, it doesn't seem your code is responsible. Likely some bug in rectangle selector (but cannot easily test as deactivating did not work in the original example due to duplicate key assignment. So I just approve the obvious improvement of you PR.

@anntzer
Copy link
Contributor Author

anntzer commented May 21, 2020

the bug is tracked at #17476.

@QuLogic
Copy link
Member

QuLogic commented May 21, 2020

The example in the class docstring for RectangleSelector uses these same keys, and should probably be synced with this example.

@timhoffm
Copy link
Member

Possibly, the example in the class docstring should be replaced by a link to this example.

@anntzer
Cleanup RectangleSelector example.
f288658 
- Don't use "q" or "a" as keys given that they are already mapped to
  "quit" and "all_axes" (even though the latter is deprecated).
- Document the interactivity directly as the axes title.
- No need to plot too many things in the axes; they're irrelevant.
@anntzer
Copy link
Contributor Author

anntzer commented May 21, 2020

indeed, just made a link instead.

@timhoffm timhoffm mentioned this pull request May 21, 2020
Closed
@QuLogic QuLogic merged commit 35808ec into matplotlib:master May 22, 2020
@QuLogic QuLogic added this to the v3.3.0 milestone May 22, 2020
@anntzer anntzer deleted the rse branch May 22, 2020 06:53
@anntzer anntzer mentioned this pull request Oct 2, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation topic: widgets/UI
Projects
None yet
Milestone
v3.3.0
Development

Successfully merging this pull request may close these issues.
3 participants
@anntzer @QuLogic @timhoffm