Skip to content

DOC: Explain how to start the mainloop after show(block=False) #29742

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

Closed
timhoffm wants to merge 1 commit into from
Closed

DOC: Explain how to start the mainloop after show(block=False) #29742

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,10 @@ def show(*args, **kwargs) -> None:

If `False` ensure that all figure windows are displayed and return
immediately. In this case, you are responsible for ensuring
that the event loop is running to have responsive figures.
that the event loop is running to have responsive figures; in the
simplest form by calling ``fig.canvas.manager.mainloop()`` which is
what a blocking show is doing internally. Note that the GUI mainloop
itself is blocking.
Comment on lines +586 to +589
Copy link
Member

@story645 story645 Mar 13, 2025

Choose a reason for hiding this comment

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

Suggested change
that the event loop is running to have responsive figures; in the
simplest form by calling ``fig.canvas.manager.mainloop()`` which is
what a blocking show is doing internally. Note that the GUI mainloop
itself is blocking.
that the event loop is running to have responsive figures. Calling ``fig.canvas.manager.mainloop()``
will work for the simple case because that is what a blocking show is doing internally. Note that the GUI mainloop is itself blocking.

I think I'm getting tripped up by what simplest form is supposed to mean here


Defaults to True in non-interactive mode and to False in interactive
mode (see `.pyplot.isinteractive`).
Expand Down
Loading