matplotlib / matplotlib/matplotlib
[Doc]: patches.FancyArrowPatch() and Donut demo: angleA and angleB not clearly defined
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 23.2k
- Fork
- 8.5k
- Merge medio
- 1g 6h
- PR unite (30g)
- 66
Descrizione
Documentation Link
Problem
The FancyArrowPatch() documentation does not adequately describe how angleA and angleB are defined, and the notes on those parameters in the regular ArrowPatch() documentation do not clearly translate to their usage in FancyArrowPatch(). This is a problem if, for example, one tries to use the Donut chart labelling example with data that results in 2 annotation boxes sitting on top of each other.
Suggested improvement
Please add the following description, or something similar, to the FancyArrowPatch() documentation or the annotate() documentation where it describes arrowprops kwargs:
angleA and angleB are both measured counterclockwise from the positive x-axis, where the vertex referenced by angleA is at the base of the arrow, and the vertex referenced by angleB is at the head of the arrow.
It might also be good to include a similar description in the donut example to specify that the vertex of angleA is where the arrow meets the textbox, and the vertex of angleB is at the point that is being annotated.
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 dalla documentazione dell’API FancyArrowPatch collegata nell’issue, quindi esamina l’esempio delle etichette dei grafici a torta e a ciambella. Chiarisci come vengono misurati angleA e angleB e a quali vertici fanno riferimento; se appropriato, aggiungi lo stesso contesto anche all’esempio della ciambella. Il lavoro è completato quando la documentazione rimuove l’ambiguità descritta nell’issue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- data-visualization, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 38/100