You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
This is still useful. In the meantime, the docs just need to make sure that any mention of colormap is accompanied by a note saying that the colormap module is indeed named cm. I think this is done fine so far, but something to be aware of.
tacaswell
modified the milestones:
2.1 (next point release),
2.2 (next next feature release)Oct 3, 2017
efiring
added a commit
to efiring/matplotlib
that referenced
this issue
Jun 11, 2018
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 ascmap = 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 danglingplt.cm
and have a dummymatplotlib.cm
module which would just import everything frommatplotlib.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.The text was updated successfully, but these errors were encountered: