Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Merged
tacaswell merged 3 commits intomatplotlib:masterfromtimhoffm:experimental-colormaps
Sep 16, 2021

Conversation

timhoffm
Copy link
Member

@timhoffmtimhoffm commentedAug 28, 2021
edited
Loading

PR Summary

  • Mark the new ColormapRegistry API as experimental
  • Add the ColormapRegistry topyplot asplt.colormaps.

Follow-up to#18503.
See also#20853.

@timhoffmtimhoffm changed the titleExperimental colormapsAdd ColormapsRegistry as experimental and add it to pyplotAug 28, 2021
@jklymak
Copy link
Member

I'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
Copy link
MemberAuthor

timhoffm commentedAug 29, 2021
edited
Loading

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.

@story645
Copy link
Member

subplots_mosaic is taggedprovisional(https://matplotlib.org/devdocs/tutorials/index.html#provisional) so should there be some sort of consistency?

@timhoffm
Copy link
MemberAuthor

timhoffm commentedAug 29, 2021
edited
Loading

I was following th "experimental" terminology from scipy. Also to me, "provisional" sounds unfinished and not in the final state. Indeed:

provisional: for the present time but likely to change:

https://dictionary.cambridge.org/dictionary/english/provisional

It's unlikely but possible that the ColormapRegistry changes, so provisional is not the right term.

@story645
Copy link
Member

story645 commentedAug 30, 2021
edited
Loading

So then should the section of the tutorials subplot mosaic is in change to experimental? Either word indicates that the API isn't final?

@timhoffm
Copy link
MemberAuthor

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.

@jklymak
Copy link
Member

We have been using "experimental" for years now, so should probably stick to that?

@timhoffm
Copy link
MemberAuthor

We have been using both, but more often "experimental":

experimental: 36 hits
https://matplotlib.org/devdocs/search.html?q=experimental#

provisional: 10 hits
https://matplotlib.org/devdocs/search.html?q=provisional#

story645 reacted with thumbs up emoji

@timhoffmtimhoffm added this to thev3.5.0 milestoneSep 3, 2021
@@ -2003,253 +2003,6 @@ def get_plot_commands():
and inspect.getmodule(obj) is this_module)


def colormaps():
"""
Copy link
Contributor

@anntzeranntzerSep 6, 2021
edited
Loading

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?)?

Copy link
MemberAuthor

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.

Copy link
Contributor

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.

@timhoffmtimhoffmforce-pushed theexperimental-colormaps branch 2 times, most recently from5a8d72e to21cbff3CompareSeptember 9, 2021 18:53
@timhoffm
Copy link
MemberAuthor

@dstansby I've clarified what experimental means here.

@tacaswelltacaswell merged commit4d6ab93 intomatplotlib:masterSep 16, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestSep 16, 2021
timhoffm added a commit that referenced this pull requestSep 16, 2021
…935-on-v3.5.xBackport PR#20935 on branch v3.5.x (Add ColormapsRegistry as experimental and add it to pyplot)
tacaswell added a commit that referenced this pull requestOct 20, 2021
ENH: Add ColormapsRegistry as experimental and add it to pyplot
ericpre pushed a commit to ericpre/matplotlib that referenced this pull requestOct 20, 2021
ENH: Add ColormapsRegistry as experimental and add it to pyplot
@timhoffmtimhoffm deleted the experimental-colormaps branchJune 10, 2022 21:18
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@anntzeranntzeranntzer left review comments

@dstansbydstansbydstansby approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.5.0
Development

Successfully merging this pull request may close these issues.

6 participants
@timhoffm@jklymak@story645@anntzer@dstansby@tacaswell

[8]ページ先頭

©2009-2025 Movatter.jp