matplotlib / matplotlib/cmocean

`cmocean.tools.print_colormaps` snippet in the docs raises an error

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

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
269
Forks
54
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Hello! I love your work, this is my favorite set of colormaps.

Today I wanted to run some code from [the docs](https://matplotlib.org/cmocean/#capabilities):

```python
import cmocean

cmaps = cmocean.cm.cmap_d
cmocean.tools.print_colormaps(cmaps)
```

and it produces the following exception and traceback:

```
Traceback (most recent call last):
File "/home/mfisher/Projects/_test/extend-colormaps-js/test.py", line 4, in
cmocean.tools.print_colormaps(cmaps)
File "/home/mfisher/Projects/_test/extend-colormaps-js/.pixi/envs/default/lib/python3.12/site-packages/cmocean/tools.py", line 25, in print_colormaps
rgbtemp = cmap(np.linspace(0, 1, N))[np.newaxis, :, :3][0]
^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: 'str' object is not callable
```

The issue appears to be here:

https://github.com/matplotlib/cmocean/blob/59c35002c3aa5296b65d9646e52604c627441eb6/cmocean/tools.py#L23

We loop over the `cmaps` object, which is a dictionary of colormap name keys to colormap object values in this invocation, but the function expects the object to be a list of colormap objects.

So the docs could be updated to:

```python
import cmocean

cmaps = cmocean.cm.cmap_d
cmocean.tools.print_colormaps(cmaps.values())
```

But after running this code I don't see the output files!

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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

Commencez par l’exemple de capabilities lié dans l’issue et par cmocean/tools.py autour de la ligne 23 ; exécutez l’extrait documenté et examinez comment print_colormaps traite son entrée et écrit la sortie. Mettez à jour l’exemple de documentation afin qu’il ne déclenche plus l’erreur signalée, et précisez ou vérifiez où ses fichiers de sortie devraient apparaître.

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

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Bug
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
52/100

Recevez les nouvelles issues par e-mail

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