updated docs with colorizer changes · matplotlib/matplotlib@cf9a943 · GitHub
Skip to content

Commit cf9a943

Browse files
trygvradtrygvrad
committed
updated docs with colorizer changes
1 parent 0aa212a commit cf9a943

5 files changed

Lines changed: 24 additions & 1 deletion

File tree

‎doc/api/colorizer_api.rst‎

Lines changed: 9 additions & 0 deletions

‎doc/api/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ Alphabetical list of modules:
9494
cm_api.rst
9595
collections_api.rst
9696
colorbar_api.rst
97+
colorizer_api.rst
9798
colors_api.rst
9899
container_api.rst
99100
contour_api.rst

‎doc/api/next_api_changes/behavior/28658-TMR.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ScalarMappable changed to ColorizingArtist
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
Classes that used to inherit from `cm.ScalarMappable` now inherit from
5+
`colorizer.ColorizingArtist` instead. All the existing attributes on
6+
`cm.ScalarMappable` are available on the equivalent `colorizer.ColorizingArtist`
7+
but type checks for `cm.ScalarMappable` will fail.

‎lib/matplotlib/colorizer.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
The Colorizer class which handles the data to color pipeline via a
33
normalization and a colormap.
44
5+
.. admonition:: Provisional status of colorizer
6+
7+
The ``colorizer`` module and classes in this file are considered provisional and may change
8+
at any time without a deprecation period.
9+
510
.. seealso::
611
712
:doc:`/gallery/color/colormap_reference` for a list of builtin colormaps.

‎lib/matplotlib/tests/test_axes.py‎

Lines changed: 2 additions & 1 deletion

0 commit comments

Comments
 (0)