Skip to content

Commit 99d0bcc

Browse files
committed
adjust docstring indentation
1 parent 30b1373 commit 99d0bcc

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

cmasher/utils.py

+18-18
Original file line numberDiff line numberDiff line change
@@ -251,43 +251,43 @@ def combine_cmaps(
251251
252252
Parameters
253253
----------
254-
*cmaps: Colormap or colormap name (str) to be combined.
255-
nodes: list or numpy array of nodes (float). Defaults: equal divisions.
256-
The blending points between colormaps, in the range [0, 1].
257-
n_rgb_levels: int. Defaults: 256.
258-
Number of RGB levels for each colormap segment.
259-
combined_cmap_name: str. Defaults: "combined_cmap".
260-
name of the combined Colormap.
254+
*cmaps: Colormap or colormap name (str) to be combined.
255+
nodes: list or numpy array of nodes (float). Defaults: equal divisions.
256+
The blending points between colormaps, in the range [0, 1].
257+
n_rgb_levels: int. Defaults: 256.
258+
Number of RGB levels for each colormap segment.
259+
combined_cmap_name: str. Defaults: "combined_cmap".
260+
name of the combined Colormap.
261261
262262
Returns
263263
-------
264-
Colormap: The composite colormap.
264+
Colormap: The composite colormap.
265265
266266
Raises
267267
------
268-
TypeError: If the list contains mixed datatypes or invalid
269-
colormap names.
270-
ValueError: If the cmaps contain only one single colormap,
271-
or if the number of nodes is not one less than the number
272-
of colormaps, or if the nodes do not contain incrementing values
273-
between 0.0 and 1.0.
268+
TypeError: If the list contains mixed datatypes or invalid
269+
colormap names.
270+
ValueError: If the cmaps contain only one single colormap,
271+
or if the number of nodes is not one less than the number
272+
of colormaps, or if the nodes do not contain incrementing values
273+
between 0.0 and 1.0.
274274
275275
Note
276276
----
277-
The colormaps are combined from low value to high value end.
277+
The colormaps are combined from low value to high value end.
278278
279279
References
280280
----------
281-
- https://stackoverflow.com/questions/31051488/combining-two-matplotlib-colormaps/31052741#31052741
281+
- https://stackoverflow.com/questions/31051488/combining-two-matplotlib-colormaps/31052741#31052741
282282
283283
Examples
284284
--------
285-
Using predefined colormap names::
285+
Using predefined colormap names::
286286
>>> custom_cmap_1 = combine_cmaps(
287287
["ocean", "prism", "coolwarm"], nodes=[0.2, 0.75]
288288
)
289289
290-
Using Colormap objects::
290+
Using Colormap objects::
291291
>>> cmap_0 = plt.get_cmap("Blues")
292292
>>> cmap_1 = plt.get_cmap("Oranges")
293293
>>> cmap_2 = plt.get_cmap("Greens")

0 commit comments

Comments
 (0)