Pending warning for deprecated parameter 'vert' of box and violin on 3.10 #29159
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
timhoffm
reviewed
Nov 20, 2024
5 tasks
|
Per the discussion in #29155 I agree this should stay as "pending". |
The new parameter, 'orientation', was only added in the current release, so downstream wanting to avoid warnings would require version gates. Therefore delaying by at least one release to ease the transition. This was motivated by Pandas failing tests on this warning. This portion is made direct to v3.10.x with matplotlib#29155 being the accompanying version to edit the deprecation on main. Reinstate warning as a pending warning STY: fits on one line
cf2b540 to
f356da1
Compare
tacaswell
approved these changes
Nov 22, 2024
timhoffm
approved these changes
Nov 23, 2024
| @@ -4361,9 +4365,10 @@ def merge_kw_rc(subkey, explicit, zdelta=0, usemarker=True): | |||
| vert = mpl.rcParams['boxplot.vertical'] | |||
| else: | |||
| _api.warn_deprecated( | |||
| "3.10", | |||
| "3.11", | |||
There was a problem hiding this comment.
I would have expected 3.10 here („pending depreciation in 3.10“) but am not sure what the message looks like („deprecated in 3.11“) would also be fine.
There was a problem hiding this comment.
The version number actually does not appear in the Pending deprecation, apparently:
PendingDeprecationWarning: vert: bool will be deprecated in a future version. Use orientation: {'vertical', 'horizontal'} instead.
Personally I think this is fine, and leaving the intended deprecation version in source reduces change when actually deprecating (though in this case, it is already fully deprecated on main, so that much doesn't really matter)
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 new parameter, 'orientation', was only added in the current release, so downstream wanting to avoid warnings
would require version gates. Therefore delaying by at least one release to ease the transition.
This was motivated by Pandas failing tests on this warning.
This portion is made direct to v3.10.x with #29155 being the accompanying version to edit the deprecation on main.
PR summary
PR checklist