NotificationsYou must be signed in to change notification settings
Fork8.1k
Star22.1k

Use explicit kwarg for plt.show()#11170

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Closed

dstansby wants to merge3 commits intomatplotlib:masterfromdstansby:show-kwarg

Closed

Use explicit kwarg for plt.show()#11170

dstansby wants to merge3 commits intomatplotlib:masterfromdstansby:show-kwarg

Conversation

Copy link

Member

ImportanceOfBeingErnestMay 4, 2018

Choose a reason for hiding this comment

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

I guess you meanreturn _show(block=block) here?

Copy link

MemberAuthor

Choose a reason for hiding this comment

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

🤦‍♂️

Copy link

Member

ImportanceOfBeingErnest commentedMay 4, 2018

I do think it's a good idea. Maybe one could even check forblock being a boolean. You won't believe how many people try to do things likeplt.show(fig1),plt.show(ax) etc. Showing a useful error in such cases may be helpful for them.

Copy link

Member

ImportanceOfBeingErnest commentedMay 5, 2018

Apparently there is a problem with the web backend which doesn't take any arguments.

dstansby force-pushed theshow-kwarg branch 2 times, most recently fromb8806d5 tod4d80e5Compare

May 5, 2018 09:40

dstansby added3 commits

May 6, 2018 21:17

Use explicit kwarg for plt.show()

b117d39

Fix block

Convert block=None to block=True

83aa94d

Fix doc

Add API notes

c10b2e0

dstansby force-pushed theshow-kwarg branch fromd4d80e5 toc10b2e0Compare

May 6, 2018 20:24

dstansby added the status: needs review label

May 6, 2018

dstansby force-pushed theshow-kwarg branch fromd72aff3 toc10b2e0Compare

May 7, 2018 14:55

tacaswell reviewed

May 7, 2018

View reviewed changes

lib/matplotlib/backends/backend_webagg.py


		@staticmethod
		defshow():
		defshow(block=True):

Copy link

Member

tacaswellMay 7, 2018

Choose a reason for hiding this comment

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

I thought we fixed this already....

Copy link

Member

tacaswell commentedMay 7, 2018

I am 👎 on changing the default value. If the user passedblock=True we should block unconditionally on any other state.

I am very 👍 on@ImportanceOfBeingErnest 's suggestion of giving a good warning in the common incorrect use of passing figures or axes toplt.show (whichdoes make sense in a guessing-the-API mode).