Deprecate 'prune' kwarg to MaxNLocator#25191
Closed
dstansby wants to merge 1 commit intomatplotlib:mainfrom
Closed
Deprecate 'prune' kwarg to MaxNLocator#25191dstansby wants to merge 1 commit intomatplotlib:mainfrom
dstansby wants to merge 1 commit intomatplotlib:mainfrom
Conversation
ksunden
reviewed
Feb 10, 2023
dstansby
force-pushed
the
deprecate-prune
branch
from
8e188b7 to
d58a817
Compare
jklymak
approved these changes
Feb 22, 2023
QuLogic
reviewed
Feb 22, 2023
Comment on lines
+2052
to
+2054
| "3.8", message="The 'prune' keyword argument is deprecated, " | ||
| "and will be removed in Matplotlib %(removal)s. Tick pruning " | ||
| "should be done manually after the ticks have been generated." |
Member
There was a problem hiding this comment.
The last sentence should be passed to addendum instead of overriding message.
| integer=False, | ||
| symmetric=False, | ||
| prune=None): | ||
| # trim argument has no effect. It has been left for API compatibility |
Member
There was a problem hiding this comment.
We should keep this comment, or also look into deprecating it as well.
| @@ -0,0 +1,6 @@ | |||
| Automatically pruning ticks in ``MaxNLocator`` | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
| The ``prune`` keyword argument to both `matplotlib.ticker.MaxNLocator` and | |||
Member
There was a problem hiding this comment.
Suggested change
| The ``prune`` keyword argument to both `matplotlib.ticker.MaxNLocator` and | |
| The *prune* keyword argument to both `matplotlib.ticker.MaxNLocator` and |
oscargus
reviewed
Feb 28, 2023
| see `.MaxNLocator` | ||
| symmetric : bool, optional | ||
| see `.MaxNLocator` | ||
| prune : {'lower', 'upper', 'both', None}, optional |
Member
There was a problem hiding this comment.
Not remove yet? Add deprecation notice instead?
Member
Author
|
It's been too long since I looked at this, and the rebase isn't simple, so I'm going to close. If someone really thinks we should get this in please shout, otherwise I won't pursue it. |
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
6 participants
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.
PR Summary
We do not seem to use
prunein any tests or examples, so it seems resonable to deprecate because:MaxNLocatorpruneis not particularly new, dating back 14 years: 0c79ba3PR 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