matplotlib / matplotlib/matplotlib.github.com
Canonicalization for 're'-inherited methods
Nessuno ha ancora preso questa issue.
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 29
- Fork
- 62
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
In 3.4.0, the docs for some Axes methods (pick, pickable, get_picker, set_picker, get_contains, set_contains) were removed. This is because the docs are inherited from the Artist methods.
Sphinx automatically switches all references when generated the docs, but our redirect/canonicalization script here doesn't recognize it. Instead, it thinks these methods were last documented in 3.3.4 and points there.
We should decide if we want to point to the new location (and figure out if it's possible), and do so.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
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 individuando lo script di reindirizzamento/canonicalizzazione e confronta la gestione dei metodi ereditati di Artist con i riferimenti generati da Sphinx. Verifica come sono rappresentati i metodi di Axes dopo la rimozione della documentazione in 3.4.0. Il lavoro è completato quando lo script indirizza questi metodi alla loro posizione canonica attuale oppure registra chiaramente che ciò non è possibile.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100