should cm be renamed to colormaps? · Issue #1476 · matplotlib/matplotlib · GitHub
Skip to content

should cm be renamed to colormaps? #1476

Description

@ivanov

It's a bit confusing to have a proper module have such a short, non-descriptive name.

Looking at code that uses it, if one were to see from matplotlib import cm - they'd be left wondering what those two letters could possibly stand for. Then further down, they'd see it being used with a keyword argument that would shed some light, such as cmap = cm.RdBu, and they would maybe go through the steps of "oh, it's a map... probably a color map"...maybe...

If the import code was written as from matplotlib import colormaps as cm, it'd be more clear. We would retain the dangling plt.cm and have a dummy matplotlib.cm module which would just import everything from matplotlib.colormaps.

as a bonus, I think plt.colormaps should be retained, but the code and documentation for it should live inside this new colormaps module.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    API: changesChanges to the public API, typically requiring deprecation.API: consistencyConsistency of the matplotlib API, including naming, behavior, defaults, …New feature

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions