Skip to content

Add descriptions for remaining event handling examples - #9333

Merged
tacaswell merged 1 commit into
matplotlib:masterfrom
divyam3897:descriptionExamples
Oct 10, 2017
Merged

tacaswell merged 1 commit into
matplotlib:masterfrom
divyam3897:descriptionExamples

Conversation

@divyam3897

Copy link
Copy Markdown
Contributor

Add one line descriptions for event handling examples
Part of #8921

PR Checklist

  • Has Pytest style unit tests
  • [ x] Code is PEP 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

Comment thread examples/event_handling/close_event.py Outdated
Close Event
===========

Show how to connect to close events

@choldgraf choldgraf Oct 9, 2017 •

Copy link
Copy Markdown
Contributor

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."

Comment thread examples/event_handling/data_browser.py Outdated
Data Browser
============

An example of how to interact with multiple canvas by selecting and highlighting

Copy link
Copy Markdown
Contributor

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.

Looking Glass
=============

Example showing the movement of a glass to view the points using mouse events on a canvas.

Copy link
Copy Markdown
Contributor

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."

Comment thread examples/event_handling/path_editor.py Outdated
Path Editor
===========

This is an example showing a cross-GUI application using

Copy link
Copy Markdown
Contributor

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.

@choldgraf

Copy link
Copy Markdown
Contributor

these are a great start! some suggestions for wording etc in the comments, then I think we're good to go

@divyam3897

Copy link
Copy Markdown
Contributor Author

@choldgraf made the changes 👍

@choldgraf

Copy link
Copy Markdown
Contributor

LGTM - will merge when tests finish

@tacaswell tacaswell added this to the 2.1.0-docs milestone Oct 9, 2017
@tacaswell

Copy link
Copy Markdown
Member

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).

@divyam3897

Copy link
Copy Markdown
Contributor Author

@tacaswell I just pushed the changes after the rebase, I hope the tests should pass now :)

@tacaswell

Copy link
Copy Markdown
Member

@divyam3897 Thanks!

@tacaswell
tacaswell merged commit 28ae8eb into matplotlib:master Oct 10, 2017
@tacaswell

Copy link
Copy Markdown
Member

Thanks @divyam3897 and congrats on your first Matplotlib contribution 🎉

Hopefully we will hear from you again!

tacaswell added a commit that referenced this pull request Oct 12, 2017
DOC: Add descriptions for remaining event handling examples
@tacaswell

Copy link
Copy Markdown
Member

backported to v2.1.0-doc as 1e6dc92

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.

4 participants