Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: tweak wording on Figure.show warning #24607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 13, 2022
Merged

DOC: tweak wording on Figure.show warning #24607

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e9ffb6
DOC: tweak wording on Figure.show warning
tacaswell Dec 3, 2022
e3252a6
DOC: fix typo
tacaswell Dec 4, 2022
77074ed
DOC: clarify wording
tacaswell Dec 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2614,18 +2614,25 @@ def show(self, warn=True):
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.
Use cases for `.Figure.show` include running this from a GUI
application (where there is persistently an event loop running) or
from a shell, like IPython, that install an input hook to allow the
interactive shell to accept input while the figure is also being
shown and interactive. Some, but not all, GUI toolkits will
register an input hook on import. See :ref:`cp_integration` for
more details.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

block=True is the default?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default depends on if we are in "interactive mode" or not.

the event loop for you.

Parameters
----------
warn : bool, default: True
If ``True`` and we are not running headless (i.e. on Linux with an
unset DISPLAY), issue warning when called on a non-GUI backend.

"""
if self.canvas.manager is None:
raise AttributeError(
Expand Down