Documentation: README disagrees with https://matplotlib.org/ipympl/

Open

#454 opened on Apr 5, 2022 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 1/5
Estimated time: Under an hour
Newbie friendliness: 45/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Stale
Tech stack: jupyter-notebook, python
Domain: documentation

Research direction

Compare README.md with the current ipympl documentation at https://matplotlib.org/ipympl/ and verify both magic commands in the reported Jupyter setup. Update the outdated example so the README and documentation agree, then confirm that the usage shown matches the supported command.

Written by the indexing model from the issue text.

Description

Describe the issue

The current README specifies that to use ipympl you simply use the following magic:

%matplotlib widget

However, the documentation specifies the following magic:

%matplotlib ipympl

The latter works for my system, while the former does not.

Versions

 3.10.3 (main, Mar 18 2022, 08:05:10) [GCC 9.4.0]
ipympl version: 0.8.8
Selected Jupyter core packages...
IPython          : 8.2.0
ipykernel        : 6.12.1
ipywidgets       : 7.7.0
jupyter_client   : 7.2.1
jupyter_core     : 4.9.2
jupyter_server   : 1.16.0
jupyterlab       : 3.3.2
nbclient         : 0.5.13
nbconvert        : 6.4.5
nbformat         : 5.3.0
notebook         : 6.4.10
qtconsole        : not installed
traitlets        : 5.1.1
Known nbextensions:
  config dir: /home/bthayer/.cache/pypoetry/virtualenvs/opf-7uscUANZ-py3.10/etc/jupyter/nbconfig
    notebook section
      jupyter-matplotlib/extension  enabled 
      - Validating: OK
      jupyter-js-widgets/extension  enabled 
      - Validating: OK
JupyterLab v3.3.2
/home/bthayer/.cache/pypoetry/virtualenvs/opf-7uscUANZ-py3.10/share/jupyter/labextensions
        jupyter-matplotlib v0.10.5 enabled OK
        @jupyter-widgets/jupyterlab-manager v3.1.0 enabled OK (python, jupyterlab_widgets)

Dominant language: Jupyter Notebook
Stars: 1.7k
Forks: 234
PR merge metrics: No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

The correction-threshold rationale says 17 restraint cases collide; the current corpus has 16 Open

area:dictation documentation P2

Difficulty 2/5 1-3 hours Newbie friendliness 78/100

uttrflow/uttrflow-swift#1180 · Opened Sep 22, 2026
[workshop-sync] workshop/17-add-mcp-tools.md: wrong workflow filename and missing safe-outputs for issue creation Open

documentation

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

githubnext/gh-aw-workshop#3692 · Opened Sep 22, 2026
[guide] README 'What lives here' site map stale after Community restructure — Members/Awards listed as top-level, 'Projects from end users' missing Open

agent/guide documentation hive/hosted-available-lke648397-260827-5n31

Difficulty 2/5 1-3 hours Newbie friendliness 90/100

cncf/endusers#456 · Opened Sep 22, 2026
Install on Debian 13 not possible Open

kind/bug

Difficulty 2/5 1-3 hours Newbie friendliness 68/100

falcosecurity/falco-website#1601 · Opened Sep 22, 2026
Improve privacy considerations Open

specification

Difficulty 1/5 1-3 hours Newbie friendliness 78/100

WICG/webmonetization#729 · Opened Sep 22, 2026