matplotlib / matplotlib/ipympl

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

Ouverte
#454 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Jupyter Notebook
Étoiles
1.7k
Forks
234
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

## Describe the issue
The [current README](https://github.com/matplotlib/ipympl/blob/3e0a520087d317c7aa7aca38ca1c5c04e7b31f44/README.md) specifies that to use `ipympl` you simply use the following magic:

```
%matplotlib widget
```

However, the [documentation](https://matplotlib.org/ipympl/) 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)

```

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Comparez README.md avec la documentation actuelle d’ipympl sur https://matplotlib.org/ipympl/ et vérifiez les deux commandes magiques dans la configuration Jupyter signalée. Mettez à jour l’exemple obsolète afin que README et la documentation concordent, puis confirmez que l’utilisation présentée correspond à la commande prise en charge.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
jupyter-notebook, python
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.