DOC: tweak wording on Figure.show warning #24607
Conversation
closes matplotlib#22169 Co-authored-by: Tim Hoffmann <[email protected]>
6f2da83 to
3e9ffb6
Compare
lib/matplotlib/figure.py
Outdated
| Some, but not all, GUI toolkits will register an input hook on | ||
| import. See :ref:`cp_integration` for more details. |
There was a problem hiding this comment.
My apologies, but I find these changes much more confusing than the original. What is an "input hook"? What is a "GUI toolkit", and why do they register an "input hook"? Where do they register it? and what does "on import" mean? On import of what?
There was a problem hiding this comment.
Note that there is a typo in the previous paragraph "an GUI even loop"...
There was a problem hiding this comment.
It does include a link to the (much) longer explanation.
#22169 noted that they found a case where it did work. The goal was to add a few more details about when you should expect this to work or not.
|
|
||
| If you're in a shell without input hook integration or executing a | ||
| python script, you should use `matplotlib.pyplot.show` with | ||
| ``block=True`` instead, which takes care of starting and running |
There was a problem hiding this comment.
The default depends on if we are in "interactive mode" or not.
Co-authored-by: Oscar Gustafsson <[email protected]>
Co-authored-by: Jody Klymak <[email protected]>
dee5614 to
77074ed
Compare
|
meeseeksdev backport to v3.6.x |
…607-on-v3.6.x Backport PR #24607 on branch v3.6.x (DOC: tweak wording on Figure.show warning)
PR Summary
closes #22169
PR Checklist
Documentation and Tests