MNT: Discourage arrow() #29509
Merged
MNT: Discourage arrow() #29509
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
We don't have an explicit policy on the version in which we introduce discourage statements. Since this is non-breaking and it's better to get the info out earlier, I pointed to the next micro release. |
The arrow() design is broken beyond repair. Even though we currently only have to offer `annotate` as a workaround, we should make the limitations more prominent then just a note and we should steer users away. This is a a step towards deprecation (matplotlib#20387). Unfortunately the discussion of a replacement has stalled (matplotlib#22435) and we have to revive it later. But that shound not hold us from pointing out the flaws of arrow() more prominently.
330f33a to
a74bf6d
Compare
rcomer
approved these changes
Jan 25, 2025
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jan 25, 2025
timhoffm
added a commit
that referenced
this pull request
Jan 25, 2025
…509-on-v3.10.x Backport PR #29509 on branch v3.10.x (MNT: Discourage arrow())
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The arrow() design is broken beyond repair. Even though we currently only have to offer
annotateas a workaround, we should make the limitations more prominent then just a note and we should steer users away.This is a a step towards deprecation (#20387). Unfortunately the discussion of a replacement has stalled (#22435) and we have to revive it later. But that shound not hold us from pointing out the flaws of arrow() more prominently.