-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Add descriptions for remaining event handling examples #9333
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
Conversation
@@ -3,6 +3,7 @@ | |||
Close Event | |||
=========== | |||
|
|||
Show how to connect to close events |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add a period!
also, could you make it a bit more clear? E.g., "Connecting events that occur when the figure closes."
@@ -3,6 +3,8 @@ | |||
Data Browser | |||
============ | |||
|
|||
An example of how to interact with multiple canvas by selecting and highlighting |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd split this into two blocks. The first sentence should be quite short and fit one one line. Something like:
Connecting data between multiple canvases.
This example covers how to interact data with multiple canvases. This
let's you select and highlight a point on one axis, and generating the
data of that point on the other axis.
@@ -3,6 +3,7 @@ | |||
Looking Glass | |||
============= | |||
|
|||
Example showing the movement of a glass to view the points using mouse events on a canvas. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Using mouse events to simulate a looking glass for inspecting data."
@@ -3,6 +3,9 @@ | |||
Path Editor | |||
=========== | |||
|
|||
This is an example showing a cross-GUI application using |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
something like...
Sharing events across GUIs.
This example demonstrates a cross-GUI application using Matplotlib event
handling to interact with and modify objects on the canvas.
these are a great start! some suggestions for wording etc in the comments, then I think we're good to go |
@choldgraf made the changes 👍 |
LGTM - will merge when tests finish |
The failures are due to circle testing the tip of the branch, not it merged into master. The version of master this is based off of is pre #9325 Who ever merges this should confirm the docs build locally (probably less work over all unless @divyam3897 is comfortable rebasing the branch onto current master). |
@tacaswell I just pushed the changes after the rebase, I hope the tests should pass now :) |
@divyam3897 Thanks! |
Thanks @divyam3897 and congrats on your first Matplotlib contribution 🎉 Hopefully we will hear from you again! |
DOC: Add descriptions for remaining event handling examples
backported to v2.1.0-doc as 1e6dc92 |
Add one line descriptions for event handling examples
Part of #8921
PR Checklist