Skip to content

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

Closed

Description

@jason-sachs

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

Activity

  1. timhoffm commented on Nov 24, 2021

    @timhoffm
    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.
  2. timhoffm commented on Dec 4, 2021

    @timhoffm
    Member

    Closed by #21743.

  3. added this to the v3.5.1 milestone on Dec 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions