FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

MNT: Discourage arrow() by timhoffm · Pull Request #29509 · matplotlib/matplotlib · GitHub

Repository navigation

MNT: Discourage arrow() - #29509

Merged
rcomer merged 1 commit into
matplotlib:mainfrom
timhoffm:mnt-discourage-arrow
Jan 25, 2025
Merged

rcomer merged 1 commit into
matplotlib:mainfrom
timhoffm:mnt-discourage-arrow

Conversation

Copy link
Copy Markdown
Member

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 (#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.

timhoffm modified the milestones: v3.10.0-doc, v3.10.1 Jan 24, 2025

Copy link
Copy Markdown
Member Author

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.

timhoffm marked this pull request as ready for review January 24, 2025 09:04
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.
timhoffm force-pushed the mnt-discourage-arrow branch from 330f33a to a74bf6d Compare January 24, 2025 09:05
timhoffm added Maintenance API: changes Changes to the public API, typically requiring deprecation. labels Jan 24, 2025
rcomer merged commit 9e3ada3 into matplotlib:main Jan 25, 2025
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 25, 2025
timhoffm deleted the mnt-discourage-arrow branch January 25, 2025 21:31
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())
ksunden mentioned this pull request Mar 3, 2025
5 tasks
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

API: changes Changes to the public API, typically requiring deprecation. Maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants


Back | FazBrowse Home | New Git URL