Skip to content

Commit 7778bc0

Browse files
Figure.makecpt: Improve the docstring of the 'reverse' parameter (#3009)
Co-authored-by: Michael Grund <[email protected]>
1 parent 1e73f9b commit 7778bc0

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

pygmt/src/makecpt.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,12 @@ def makecpt(**kwargs):
121121
level :func:`pygmt.makecpt` is called.
122122
reverse : str
123123
Set this to ``True`` or **c** [Default] to reverse the sense of color
124-
progression in the master CPT. Set this to **z** to reverse the sign
125-
of z-values in the color table. Note that this change of z-direction
126-
happens before ``truncate`` and ``series`` values are used so the
127-
latter must be compatible with the changed z-range. See also
124+
progression in the master CPT. Also the foreground and background colors
125+
are exchanged, including those specified by :gmt-term:`COLOR_BACKGROUND` and
126+
:gmt-term:`COLOR_FOREGROUND`. Set this to **z** to reverse the sign of z-values
127+
in the color table. Note that this change of the z-direction happens before
128+
the ``truncate`` and ``series`` values are used, so the latter must be
129+
compatible with the changed z-range. See also
128130
:gmt-docs:`reference/features.html#manipulating-cpts`.
129131
overrule_bg : str
130132
Overrule background, foreground, and NaN colors specified in the master

0 commit comments

Comments
 (0)