Update event handling docs. #19022
Merged
Update event handling docs. #19022
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timhoffm
reviewed
Nov 26, 2020
doc/users/event_handling.rst
Outdated
|
|
||
| ``button`` | ||
| button pressed None, 1, 2, 3, 'up', 'down' (up and down are used for scroll events) | ||
| the button pressed: None, 1, 2, 3, 'up', 'down' (up and down are used for scroll events) |
There was a problem hiding this comment.
Suggested change
| the button pressed: None, 1, 2, 3, 'up', 'down' (up and down are used for scroll events) | |
| the button pressed: None or `.MouseButton` |
doc/users/event_handling.rst
Outdated
| @@ -162,12 +148,12 @@ Draggable rectangle exercise | |||
| ---------------------------- | |||
|
|
|||
| Write draggable rectangle class that is initialized with a | |||
| :class:`~matplotlib.patches.Rectangle` instance but will move its x,y | |||
| `.Rectangle` instance but will move its x,y | |||
There was a problem hiding this comment.
Suggested change
| `.Rectangle` instance but will move its x,y | |
| `.Rectangle` instance but will move its ``xy`` |
doc/users/event_handling.rst
Outdated
| print('event contains', self.rect.xy) | ||
| x0, y0 = self.rect.xy | ||
| self.press = x0, y0, event.xdata, event.ydata | ||
| self.press = self.rect.xy, event.xdata, event.ydata |
There was a problem hiding this comment.
This would be (x0, y0), event.xdata, event.ydata. Is this change intentional?
Edit: Seems like. But then I'd go for self.rect.xy, (event.xdata, event.ydata) so that below you have (x0, y0), (xpress, ypress) = self.press. Using a tuple only for one of the coordinates would be a bit awkward.
doc/users/event_handling.rst
Outdated
| print('event contains', self.rect.xy) | ||
| x0, y0 = self.rect.xy | ||
| self.press = x0, y0, event.xdata, event.ydata | ||
| self.press = self.rect.xy, event.xdata, event.ydata |
doc/users/event_handling.rst
Outdated
| become additional attributes on the `.PickEvent`. | ||
|
|
||
| The artist's ``pickradius`` property can additionally be set to a tolerance | ||
| value (in points; there are 72 points per inch) that determines how far the |
There was a problem hiding this comment.
Suggested change
| value (in points; there are 72 points per inch) that determines how far the | |
| value in points (there are 72 points per inch) that determines how far the |
IMHO the unit is first-class information that should not be parenthesed.
If you think that's too ambiguous, use e.g. tolerance value in units of points
doc/users/event_handling.rst
Outdated
| ax.text(0.05, 0.9, 'mu=%1.3f\nsigma=%1.3f'%(xs[dataind], ys[dataind]), | ||
| transform=ax.transAxes, va='top') | ||
| ax.text(0.05, 0.9, | ||
| 'mu=%1.3f\nsigma=%1.3f' % (xs[dataind], ys[dataind]), |
There was a problem hiding this comment.
Fancy using TeX?
Suggested change
| 'mu=%1.3f\nsigma=%1.3f' % (xs[dataind], ys[dataind]), | |
| f'$\mu$={xs[dataind]:1.3f}\n$\sigma$={ys[dataind]:1.3f}', |
Much reformatting. Remove documentation for `picker=<float>` which is deprecated in favor of `pickradius`. Add reference to default keymaps. Modernize examples: use `pickradius`, use `subplots()` instead of `add_subplot(111)`, etc.
|
yes to all (except for turning into a tutorial, which can be done separately) |
timhoffm
approved these changes
Nov 27, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Much reformatting.
Remove documentation for
picker=<float>which is deprecated in favorof
pickradius.Add reference to default keymaps (closes #11472).
Modernize examples: use
pickradius, usesubplots()instead ofadd_subplot(111), etc.PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).