Deprecate TextWithDash. #13548
Merged
Deprecate TextWithDash. #13548
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
|
good catch, should be fixed now (it was due to an awkward interaction between delete_parameter and the pyplot wrapper for text()). |
|
What do you intend to do with the example that uses this functionality? Rewrite in terms of |
TextWithDash appears to be an ancestral version of Annotation that was added over two commits in 2005 (6a4d343, fe80816), revised once in 2006 and another time in 2008, and never touched since then. While it "works", its implementation is 400 lines long, it is only mentioned by a single example (dashpointlabel.py), somewhat complicates Axes.text(), and is likely rarely used and replaceable by Annotation for most use cases. Hence, deprecate it, keeping open the option to undeprecate if this turns out to be too disruptive.
|
I added a filter to hide the warning from the example output, but have it in the generated plot instead. I'd just delete the example once withdash goes away; there's more than enough annotate() examples lying around. |
ImportanceOfBeingErnest
approved these changes
Mar 1, 2019
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Mar 1, 2019
dstansby
added a commit
that referenced
this pull request
Mar 1, 2019
…548-on-v3.1.x Backport PR #13548 on branch v3.1.x (Deprecate TextWithDash.)
6 tasks
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.
TextWithDash appears to be an ancestral version of Annotation that was
added over two commits in 2005 (6a4d343, fe80816), revised once in 2006
and another time in 2008, and never touched since then.
While it "works", its implementation is 400 lines long, it is only
mentioned by a single example (dashpointlabel.py), somewhat complicates
Axes.text() (#12215), and is likely rarely used and replaceable by Annotation for
most use cases.
Hence, deprecate it, keeping open the option to undeprecate if this
turns out to be too disruptive. (I suggest to get the deprecation in 3.1
to give longer notice to users; I don't mind a longer deprecation period
(in numbers of minor releases) here.)
PR Summary
PR Checklist