Skip to content

Commit 57d7292

Browse files
committed
update colormap choice
1 parent 99d0bcc commit 57d7292

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed
48 Bytes
Loading

docs/source/user/usage.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -115,23 +115,23 @@ For that reason, below is an overview of all colormaps in *CMasher* (and the rev
115115

116116
Combine colormaps
117117
-----------------
118-
*CMasher* offers a utility function :func:`~cmasher.combine_cmaps`, which enables the combination of multiple colormaps at specified ``nodes`` (where a node denotes the point separating adjacent colormaps). You can directly pass several colormaps using the function like so :pycode:`cmr.combine_cmaps("cmr.rainforest", "Pastel2", "PuBu")`. By default, each sub-colormap occupies an equal portion of the combined colormap.
118+
*CMasher* offers a utility function :func:`~cmasher.combine_cmaps`, which enables the combination of multiple colormaps at specified ``nodes`` (where a node denotes the point separating adjacent colormaps). You can directly pass several colormaps using the function like so :pycode:`combine_cmaps("cmr.rainforest", "cmr.torch_r")`. By default, each sub-colormap occupies an equal portion of the final colormap.
119119

120120
.. figure:: images/combine_cmaps_equal.png
121-
:alt: Combine three colormaps with default equal separation.
121+
:alt: Combine two colormaps with default equal separation.
122122
:width: 100%
123123
:align: center
124124

125-
Combine three colormaps with default equal separation.
125+
Combine two colormaps with default equal separation.
126126

127-
Alternatively, you could also manually specify the ``nodes``. For example :pycode:`cmr.combine_cmaps("cmr.rainforest", "Pastel2", "PuBu", nodes=[0.5, 0.75])` would allocate the starting 50% of the entire colormap to "cmr.rainforest", following 25% to "Pastel2" and the remaining 25% to "PuBu".
127+
Alternatively, you could also manually specify the ``nodes``. For example :pycode:`cmr.combine_cmaps("cmr.rainforest", "cmr.torch_r", nodes=[0.75])` would allocate the starting 75% of the final colormap to "cmr.rainforest"and the remaining 25% to "cmr.torch_r".
128128

129-
.. figure:: images/combine_cmaps_0.5_0.25_0.25.png
130-
:alt: Combine three colormaps with a 50%/25%/25% separation.
129+
.. figure:: images/combine_cmaps_0.75_0.25.png
130+
:alt: Combine two colormaps with a 75%/25% separation.
131131
:width: 100%
132132
:align: center
133133

134-
Combine three colormaps with a 50%/25%/25% separation.
134+
Combine two colormaps with a 75%/25% separation.
135135

136136

137137
Command-line interface (CLI)

0 commit comments

Comments
 (0)