Update docs on Axes.set_prop_cycle #10662
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
|
Restarted the one failed travis build. The failure seems transient. |
|
link to the matplotlib cycler. The only difference between it and the
external one is that it has input validation, which was needed for use in
rc params (want to catch invalid values as early as possible).
As for the two ways to do cyclers, that has some history. Initially (in the
external cycler) package, you were supposed to have a cycler for each
element, so the two argument form was the only form you could use. You then
would use the binary operators to construct the final cycler. However, as I
developed the property cycler feature, I found that that restriction wasn't
very friendly for users who just want a simple zip-like cycle. So, a bunch
of us worked on expanding the API a bit to allow a few different
constructions. They are all valid and I wouldn't want to go down any
deprecation routes for this.
…On Fri, Mar 16, 2018 at 9:25 AM, Paul Hobson ***@***.***> wrote:
Restarted the one failed travis build. The failure seems transient.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#10662 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AARy-LBJ-_r477qlgPhCtFe6QO7VJk57ks5te71FgaJpZM4SbA2f>
.
|
c5b290d to
962a2d7
Compare
anntzer
approved these changes
Mar 21, 2018
phobson
added a commit
that referenced
this pull request
Mar 21, 2018
Backport PR #10662 on branch v2.2.x
|
@anntzer I share your view on At best, it could be deprecated at cycler.Cycler, but a smaller step in rcsetup.cycler or maybe only in |
|
You can always try to open a PR for that :-) |
|
The two arg form comes from the cycler package. I would suggest starting
there. Most users don't know there are actually two cyclers, one in the
package, and one internal to matplotlib. So, they work off of the
documentation for the package. So, if you want to get rid of the two-arg
form, you need to get rid of it there first.
The tricky part for deprecation is that, IIRC, the matplotlib cycler
construction is largely pass-through. So, it you deprecate it there first,
you would need to write a bit of shim code to convert the two-arg form into
the keyword form under-the-hood. Seriously, is it really worth the effort
to go through this for something that isn't broken? Don't forget that
you'll have to update all of the unit tests, too.
I am totally fine with not having examples with the two-arg form, but I
really just don't see the point in getting rid of it. I think we got bigger
fish to fry, here.
…On Wed, Mar 21, 2018 at 7:34 PM, Antony Lee ***@***.***> wrote:
You can always try to open a PR for that :-)
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#10662 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AARy-NqHlEBg3NwEw_YjM384dgKGGXCWks5tguNxgaJpZM4SbA2f>
.
|
3 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
Documentation update.
Questions
:func:`cycler`does not link. I'm unclear where it should go. There ismatplotlib.rcsetup.cyclerand the externalcycler.cycler. Which one is recommended?set_prop_cycle(label, values)in favor of the equivalentset_prop_cycle(label=values). There's no need for additionally supporting the first version and it's not quite pythonic after all.