Deprecate BrokenBarHCollection. #24864
Merged
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
story645
requested changes
Jan 1, 2023
|
|
||
| Shade regions where a logical mask is True with `.Axes.fill_between` or with | ||
| `matplotlib.collections.BrokenBarHCollection.span_where`. | ||
| the deprecated `matplotlib.collections.BrokenBarHCollection.span_where`. |
There was a problem hiding this comment.
I'm moderately pro-deprecating in order to reduce the number of ways to do things, but then I think you should go all in and only show the recommend (new way) to do this in the example.
There was a problem hiding this comment.
The point is to document the transition path; the old way will be removed once the deprecation elapses.
There was a problem hiding this comment.
I get doing that in the API docs, but why would someone looking at the examples need to know about the deprecated way to do something?
It doesn't warrant a separate class; also, directly doing the unit conversion in broken_barh is actually easier (one doesn't need to go through _convert_dx, instead we directly move to using xmin/xmax).
story645
approved these changes
Jan 2, 2023
oscargus
approved these changes
Jan 6, 2023
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.
It doesn't warrant a separate class; also, directly doing the unit conversion in broken_barh is actually easier (one doesn't need to go through _convert_dx, instead we directly move to using xmin/xmax).
Closes #15973 (... by making the user use fill_between instead).
See also #24827 and #4897 (where I assume the first item refers to BrokenBarHCollection, as there's no BarHCollection).
I milestoned as 3.7 due to the deprecation, but can just rewrite it as a 3.8 deprecation as well.
PR Summary
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst