Deprecate Tick.apply_tickdir. #19655
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
apply_tickdir doesn't actually update the tick markers on the existing
Line2D objects used to draw the ticks (as can be checked with e.g.
`plt.gca().xaxis.majorTicks[2].apply_tickdir("inout")`), so it's really
mostly an internal helper that cannot be meaningfully called from
outside (it needs to cooperate with `_apply_params` to actually work).
timhoffm
approved these changes
Mar 6, 2021
| @@ -209,15 +209,18 @@ def _set_labelrotation(self, labelrotation): | |||
| _api.check_in_list(['auto', 'default'], labelrotation=mode) | |||
| self._labelrotation = (mode, angle) | |||
|
|
|||
| def apply_tickdir(self, tickdir): | |||
| def _apply_tickdir(self, tickdir): | |||
There was a problem hiding this comment.
Since you've dug into the logic: Can you extend the docstring to explain what this does/not, and how it has to be used with _apply_params. (Or if thats the case: that it only works when called from within _apply_params?
There was a problem hiding this comment.
I further simplified the coordination between apply_params and apply_tickdir by getting rid of _tickmarkers (directly setting them in apply_tickdir) and letting apply_params be in charge of staleness.
Also extended the comment to explain what _appky_tickdir is responsible for.
jklymak
approved these changes
Mar 7, 2021
... which is otherwise just an attribute to coordinate between _apply_params and _apply_tickdir.
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.
apply_tickdir doesn't actually update the tick markers on the existing
Line2D objects used to draw the ticks (as can be checked with e.g.
plt.gca().xaxis.majorTicks[2].apply_tickdir("inout")), so it's reallymostly an internal helper that cannot be meaningfully called from
outside (it needs to cooperate with
_apply_paramsto actually work).PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).