Skip to content

Commit 77074ed

Browse files
tacaswelljklymak
andcommitted
DOC: clarify wording
Co-authored-by: Jody Klymak <[email protected]>
1 parent e3252a6 commit 77074ed

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

lib/matplotlib/figure.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2614,11 +2614,13 @@ def show(self, warn=True):
26142614
may only be shown briefly or not shown at all if you or your
26152615
environment are not managing an event loop.
26162616
2617-
Proper use cases for `.Figure.show` include running this from a GUI
2617+
Use cases for `.Figure.show` include running this from a GUI
26182618
application (where there is persistently an event loop running) or
2619-
from a shell with an input hook configured (IPython will do this).
2620-
Some, but not all, GUI toolkits will register an input hook on
2621-
import. See :ref:`cp_integration` for more details.
2619+
from a shell, like IPython, that install an input hook to allow the
2620+
interactive shell to accept input while the figure is also being
2621+
shown and interactive. Some, but not all, GUI toolkits will
2622+
register an input hook on import. See :ref:`cp_integration` for
2623+
more details.
26222624
26232625
If you're in a shell without input hook integration or executing a
26242626
python script, you should use `matplotlib.pyplot.show` with
@@ -2630,6 +2632,7 @@ def show(self, warn=True):
26302632
warn : bool, default: True
26312633
If ``True`` and we are not running headless (i.e. on Linux with an
26322634
unset DISPLAY), issue warning when called on a non-GUI backend.
2635+
26332636
"""
26342637
if self.canvas.manager is None:
26352638
raise AttributeError(

0 commit comments

Comments
 (0)