Skip to content
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.

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

[Doc]: relpos is not valid for FancyArrowPatch #21732

Closed
jason-sachs opened this issue Nov 23, 2021 · 2 comments
Closed

[Doc]: relpos is not valid for FancyArrowPatch #21732

jason-sachs opened this issue Nov 23, 2021 · 2 comments
Milestone

Comments

@jason-sachs
Copy link

Documentation Link

https://matplotlib.org/stable/api/text_api.html

Problem

arrowprops section states

Valid keys for FancyArrowPatch are:
...
relpos

but relpos is not a valid kwarg for FancyArrowPatch.

Suggested improvement

Fix so that the docs state allowable keys. I can't figure out when relpos is allowed and when it is not.

Matplotlib Version

3.4.3

@timhoffm
Copy link
Member

This seems like a leftover from removing YAArrow (#4178).

The arrowprops docstring is outdated in multiple ways:

  • the width, headwidth headlength, shrink, frac parameters are only allowed if there is no "arrowstyle". But they are ignored - should probably be deprecated.
  • Three are now more arrowstyles available from FancyArrowPatch.
  • relpos is not a FancyArrowPatch attribute. It's handled explicitly - functionality to be inferred from the code.

@timhoffm
Copy link
Member

timhoffm commented Dec 4, 2021

Closed by #21743.

@timhoffm timhoffm closed this as completed Dec 4, 2021
@QuLogic QuLogic added this to the v3.5.1 milestone Dec 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants