Doc draw event details #9505
Merged
Doc draw event details #9505
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
NelleV
reviewed
Oct 21, 2017
| .. warning :: | ||
|
|
||
| Calling ``canvas.draw`` and ``canvas.blit`` in these callbacks may | ||
| not be safe with all backends and may cause infinite recursion. |
There was a problem hiding this comment.
It is nice to at least warn the user they have acquired a foot-cannon.....
8d6e1d3 to
5a6ae81
Compare
|
pep8 fixed and force-pushed |
jklymak
reviewed
Oct 22, 2017
lib/matplotlib/backend_bases.py
Outdated
|
|
||
| In most backends callbacks subscribed to this callback will be | ||
| fired after the rendering is complete but before the screen is | ||
| update. Any extra artists drawn to the canvas's renderer will |
lib/matplotlib/backend_bases.py
Outdated
| In most backends callbacks subscribed to this callback will be | ||
| fired after the rendering is complete but before the screen is | ||
| update. Any extra artists drawn to the canvas's renderer will | ||
| be reflected without an explicate call to ``blit``. |
There was a problem hiding this comment.
explicate -> explicit (unless an "explicate call" is a jargon I don't know.)
This does not prevent the recursion, which may segfault Qt, but prevents it from infinitely recursing if Qt does not crash. Closes matplotlib#9406
5a6ae81 to
9b8a944
Compare
|
Spelling fixed and force-pushed. |
jklymak
reviewed
Oct 23, 2017
| @@ -1428,6 +1428,17 @@ class DrawEvent(Event): | |||
| In addition to the :class:`Event` attributes, the following event | |||
| attributes are defined: | |||
There was a problem hiding this comment.
I think this sentence needs to get moved down now? Sorry should have read the whole docstrig before my previous comment...
There was a problem hiding this comment.
Done, but the diff resolved with out this line changing.
jklymak
approved these changes
Oct 23, 2017
5 tasks
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.
Summarizes the discussion from #9406 in the docs and tweaks the latch on the Qt*AGg.__draw_idle_agg to prevent infinite recession (will still get one level) if miss-used.