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.

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

Make 'Usage' section in README consistent with current Basic Example at current documentation #583

Merged
merged 1 commit into from
Mar 5, 2025

Conversation

fomightez
Copy link
Contributor

The current Basic Example in the documentation here uses:

%matplotlib ipympl

This is nice/explicit and emphasizes you need ipympl installed. The documentation there further reads, 'Alternatively you can use %matplotlib widget which will have the same effect.' This is good because lets legacy users know they can still use %matplotlib widget.

However, the current README at the ipympl Github repo suggest usage here in 'Usage' section only as %matplotlib widget.
It would be nice if it was consistent and explicit as I see users posting as if %matplotlib ipympl and %matplotlib widget are distinct, despite modern Jupyter needing ipympl.

Copy link
Contributor

github-actions bot commented Jan 6, 2025

Binder 👈 Launch a binder notebook on branch fomightez/ipympl/fix_usage_in_README

@ianhi
Copy link
Collaborator

ianhi commented Mar 5, 2025

I like it, thanks!

@ianhi ianhi merged commit 83994fa into matplotlib:main Mar 5, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants