Add labels parameter to set_ticks() #20047
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
jklymak
approved these changes
Apr 22, 2021
5c3983f to
ddee963
Compare
anntzer
reviewed
May 3, 2021
anntzer
reviewed
May 3, 2021
anntzer
approved these changes
May 3, 2021
QuLogic
reviewed
May 4, 2021
|
I think the doc error is real: |
ed54043 to
9e5b1d6
Compare
This was referenced Aug 18, 2021
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.
PR Summary
As proposed in #18848 (comment) and discussed on today's dev call.
Closes #18848, #19016.
kwargs: I've added kwargs for text properties. While this makes the function do a lot (borderline of too much), it is necessary if we want a full replacement of
set_ticklabels(labels, **text_properties).One can argue that this is actually too much, in which case we'd have to advertise
Return value:
set_ticks()has an undocumented return value (list of the Tick instances). Whileplt.xticks()returns a tuple(locs, labels)(list of Ticks and list of Texts), I don't want to do this here. First, I don't think the setter should return anything at all (but that's how it is for now and deprecating that is probably not worth it). Second, since labels are optional, I'm not even sure if we would want to give the texts only iflabelsis not None.