Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Add ColormapsRegistry as experimental and add it to pyplot#20935
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
281b31c
to111003d
CompareI'm a little confused about marking this as experimental? Isn't this the only way to manage the colormap registry? Or is your point that the access methods etc are experimental, but the old API still exists? |
timhoffm commentedAug 29, 2021 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Yes, the old API still exists. On the dev call we decided to be on the safe side and mark the new API as experimental to still have the freedom to change everything. Dee also the transition path in#20853. |
111003d
to99f7606
Comparesubplots_mosaic is tagged |
timhoffm commentedAug 29, 2021 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
I was following th "experimental" terminology from scipy. Also to me, "provisional" sounds unfinished and not in the final state. Indeed:
https://dictionary.cambridge.org/dictionary/english/provisional It's unlikely but possible that the ColormapRegistry changes, so provisional is not the right term. |
story645 commentedAug 30, 2021 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
So then should the section of the tutorials subplot mosaic is in change to experimental? Either word indicates that the API isn't final? |
I think so. Both indicate not final, but in my understanging "provisional" = likely to change; "experimental" = might still change. But that should be re-checked by native speakers. |
We have been using "experimental" for years now, so should probably stick to that? |
We have been using both, but more often "experimental": experimental: 36 hits provisional: 10 hits |
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
@@ -2003,253 +2003,6 @@ def get_plot_commands(): | |||
and inspect.getmodule(obj) is this_module) | |||
def colormaps(): | |||
""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Should this docstring be copied (with slight editing) intoColormapRegistry.__doc__
, e.g. into a Notes section (so that it is still available e.g. under ipython withplt.colormaps?
)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I don't think so. The old docstring is a bit tutorial plus a long description of all available colormaps. This is essentially all covered in thecolormap reference and thecolormap tutorials. The docstring ofColormapRegistry
should essentially be limited to the API.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I guess the question is, do we want to have a description of all colormaps available "offline" from just standard docstrings. But perhaps that would be better served by having some colormap metadata anyways... so that discussion can happen later.
5a8d72e
to21cbff3
Compare@dstansby I've clarified what experimental means here. |
21cbff3
to2ee48ca
Compare2ee48ca
toabd8213
Compare…nd add it to pyplot
…935-on-v3.5.xBackport PR#20935 on branch v3.5.x (Add ColormapsRegistry as experimental and add it to pyplot)
ENH: Add ColormapsRegistry as experimental and add it to pyplot
ENH: Add ColormapsRegistry as experimental and add it to pyplot
Uh oh!
There was an error while loading.Please reload this page.
PR Summary
pyplot
asplt.colormaps
.Follow-up to#18503.
See also#20853.