matplotlib / matplotlib/matplotlib
[MNT]: Clarify whether the values of an AxesImage are known as "data" or as "array"
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 23.2k
- Fork
- 8.5k
- Merge medio
- 1g 6h
- PR unite (30g)
- 66
Descrizione
### Summary
The docstring of `AxesImage.set_array` says "Retained for backwards compatibility - use set_data instead.", but on the getter side, only `get_array` (inherited from ScalarMappable) exists -- `get_data` doesn't even exist.
### Proposed fix
Be consistent as to which name, "data" or "array", is used. I suspect they could even be made aliases of one another at the ScalarMappable level...
(Perhaps also distantly related to the colorizer-related API changes.)
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia confrontando la docstring di AxesImage.set_array con ScalarMappable.get_array e verifica la possibile relazione con le modifiche all’API relative a colorizer menzionate nell’issue. Il lavoro è completato quando il progetto ha uno schema di denominazione deciso e coerente per questi valori e il comportamento rilevante di getter/setter e la documentazione riflettono tale decisione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- api, data-visualization
- Tipo di issue
- Refactoring
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100