diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py index 653455b0b6dd..b22b2356150e 100644 --- a/lib/matplotlib/figure.py +++ b/lib/matplotlib/figure.py @@ -411,6 +411,18 @@ def show(self, warn=True): :class:`~matplotlib.backend_bases.FigureManagerBase`, and will raise an AttributeError. + .. warning:: + This does not manage an GUI event loop. Consequently, the figure + may only be shown briefly or not shown at all if you or your + environment are not managing an event loop. + + Proper use cases for `.Figure.show` include running this from a + GUI application or an IPython shell. + + If you're running a pure python shell or executing a non-GUI + python script, you should use `matplotlib.pyplot.show` instead, + which takes care of managing the event loop for you. + Parameters ---------- warn : bool