Skip to content
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

Jump to bottom

rename mpl_gui.show #16

Closed
tacaswell opened this issue Nov 1, 2023 · 2 comments
Closed

rename mpl_gui.show #16

tacaswell opened this issue Nov 1, 2023 · 2 comments

Comments

@tacaswell
Copy link
Member

The name is a good one, but mpl_gui.show (which requires a list of Figures to be passed) has a very different API than FigureRegistry.show (and mpl_gui.registry.show) and matplotlib.pyplot.show (to which you may not pass a list of Figures).

The current leading contender is display
@jklymak
Copy link
Member

jklymak commented Nov 1, 2023

Is it the same idea as "draw" or does it do more than just draw the listed figures?

@tacaswell tacaswell mentioned this issue Nov 1, 2023
Merged
tacaswell added a commit to tacaswell/mpl-gui that referenced this issue Nov 1, 2023
@tacaswell
API: rename mg.show -> mg.display
be5c52e 
Having a conversation about this it was impossible to keep straight with the
two meanings of `show`.

closes matplotlib#16
@tacaswell
Copy link
Member Author

It does the actual creation of the GUI elements, puts them on screen, and then spins the event loop. I went with display in #17.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tacaswell @jklymak