-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
DOC: Really add an arrow tutorial #11350
Copy link
Copy link
Closed as not planned
Labels
DocumentationDocumentation: tutorialsfiles in galleries/tutorialsfiles in galleries/tutorialsstatus: closed as inactiveIssues closed by the "Stale" Github Action. Please comment on any you think should still be open.Issues closed by the "Stale" Github Action. Please comment on any you think should still be open.status: inactiveMarked by the “Stale” Github ActionMarked by the “Stale” Github Actiontopic: arrow
Milestone
Metadata
Metadata
Assignees
Labels
DocumentationDocumentation: tutorialsfiles in galleries/tutorialsfiles in galleries/tutorialsstatus: closed as inactiveIssues closed by the "Stale" Github Action. Please comment on any you think should still be open.Issues closed by the "Stale" Github Action. Please comment on any you think should still be open.status: inactiveMarked by the “Stale” Github ActionMarked by the “Stale” Github Actiontopic: arrow
In #11219 and #11223 @dstansby headed out to provide an arrow tutorial. Since the scope of this was rather limited, it ended up as an example examples/shapes_and_collections/arrow_guide.py - which is great.
However as mentionned in this PR #11223 there are a lot of other things to consider about arrows. In the end it would be good to have something like a complete "Arrow tutorial". I'm collecting the comments in this thread for them not to get lost, once someone has more time to write this up.
There currently are already the annotation_demo example and the annotations tutorial. So I wonder in how far they are overlapping or not. Independent of that, there should be links in between them.
In addition, the following things should be considered when writing :
ax.arrow,ax.annotate,ax.quiver,mpatches.FancyArrowPatch?patchesdoc would directly ask: "What is the difference betweenArrow,FancyArrow,FancyArrowPatchandYAArrow?" A tutorial might want to answer this.head_length,head_width,tail_width,mutation_scale, etc.?FancyArrowPatchin a collection? What's the alternative? (should be checked when deprecating other arrows)ConnectionPatchinstead of aFancyArrowPatch?plt.arrow'slength_includes_headand possiblyhead_starts_at_zero-> plt.arrow start and end locations are wrong #12768