8000 DOC: Really add an arrow tutorial · Issue #11350 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: Really add an arrow tutorial #11350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
ImportanceOfBeingErnest opened this issue May 31, 2018 · 3 comments
Closed

DOC: Really add an arrow tutorial #11350

ImportanceOfBeingErnest opened this issue May 31, 2018 · 3 comments
Labels
Documentation: tutorials files in galleries/tutorials Documentation status: closed as inactive Issues closed by the "Stale" Github Action. Please comment on any you think should still be open. status: inactive Marked by the “Stale” Github Action topic: arrow
Milestone
v3.8-doc

Comments

@ImportanceOfBeingErnest
Copy link
Member
ImportanceOfBeingErnest commented May 31, 2018 •
edited
Loading

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 :

  • what is the relation between ax.arrow, ax.annotate, ax.quiver, mpatches.FancyArrowPatch?
  • Any user looking at the patches doc would directly ask: "What is the difference between Arrow, FancyArrow, FancyArrowPatch and YAArrow?" A tutorial might want to answer this.
  • The problem when drawing arrows is mostly to understand all the different parameters. Common questions could be
    • How to make the head larger?
    • What are the units of head_length, head_width, tail_width, mutation_scale, etc.?
    • Why is my arrow shorter than the distance between the two points I specified?
    • Why can't I use an FancyArrowPatch in a collection? What's the alternative? (should be checked when deprecating other arrows)
    • How do I draw an arrow with a dotted tail?
    • When should I use a ConnectionPatch instead of a FancyArrowPatch?
  • Is the arrow_demo useful? Can it be replaced by something simpler? Definitely explain plt.arrow's length_includes_head and possibly head_starts_at_zero -> plt.arrow start and end locations are wrong #12768
  • Apperently it's not possible to get an arrow with a bolder connection path in the middle and two arrow heads on both sides? (This SO question) Need to check.
@jklymak jklymak modified the milestones: v3.0, v3.1 May 31, 2018
Open
@jklymak jklymak modified the milestones: v3.1.0, v3.2.0 Feb 4, 2019
Closed
6 tasks
@timhoffm timhoffm modified the milestones: v3.2.0, v3.3.0 Aug 11, 2019
@QuLogic QuLogic modified the milestones: v3.3.0, v3.4.0 May 7, 2020
@QuLogic QuLogic modified the milestones: v3.4.0, v3.5.0 Jan 27, 2021
@Adrien-Luxey
Copy link

I'm currently struggling with FancyArrowPatch's path parameter, which essentially disables a lot of heavy-lifting done by this class when called with posA & posB. My concrete problem is that shrinkA & shrinkB parameters are not interpreted using path; however I can't reproduce their behavior using NetworkX (the arrow head ends up under the vertex the arrow is pointing to).

@jklymak
Copy link
Member
jklymak commented May 4, 2021

Please discuss on discourse.Matplotlib.org. Or if you have a bug, open an issue with a self-contained example.

@story645 story645 mentioned this issue Jun 11, 2021
Open
@QuLogic QuLogic modified the milestones: v3.5.0, v3.6.0 Sep 25, 2021
@QuLogic QuLogic modified the milestones: v3.6.0, v3.7.0 Jul 8, 2022
@ksunden ksunden modified the milestones: v3.7.0, v3.7.1 Feb 14, 2023
@QuLogic QuLogic modified the milestones: v3.7.1, v3.7-doc Mar 4, 2023
@story645 story645 added Documentation: tutorials files in galleries/tutorials and removed Documentation: overhaul labels Jul 17, 2023
@QuLogic QuLogic removed this from the v3.7-doc milestone Sep 9, 2023
@QuLogic QuLogic added this to the v3.8-doc milestone Sep 9, 2023
@github-actions GitHub Actions
Copy link
github-actions bot commented Sep 9, 2024

This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help!

@github-actions github-actions bot added the status: inactive Marked by the “Stale” Github Action label Sep 9, 2024
@github-actions github-actions bot added the status: closed as inactive Issues closed by the "Stale" Github Action. Please comment on any you think should still be open. label Oct 9, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation: tutorials files in galleries/tutorials Documentation status: closed as inactive Issues closed by the "Stale" Github Action. Please comment on any you think should still be open. status: inactive Marked by the “Stale” Github Action topic: arrow
Projects
None yet
Milestone
v3.8-doc
Development

No branches or pull requests
8 participants
@QuLogic @story645 @jklymak @ksunden @timhoffm @dstansby @Adrien-Luxey @ImportanceOfBeingErnest
0