@@ -85,45 +85,45 @@ def makecpt(**kwargs):
85
85
:gmt-term:`COLOR_FOREGROUND`, and :gmt-term:`COLOR_NAN`]. Use
86
86
``background="i"`` to match the colors for the lowest and highest
87
87
values in the input (instead of the output) CPT.
88
- color_model :
89
- [**R**\|\ **r**\|\ **h**\|\ **c**][**+c**\ [*label*]].
88
+ color_model : str
89
+ [**R**\|\ **r**\|\ **h**\|\ **c**]\
90
+ [**+c**\ [*label*\|\ *start*\ [**-**]]].
90
91
Force output CPT to be written with r/g/b codes, gray-scale values or
91
92
color name (**R**, default) or r/g/b codes only (**r**), or h-s-v codes
92
93
(**h**), or c/m/y/k codes (**c**). Optionally or alternatively, append
93
94
**+c** to write discrete palettes in categorical format. If *label* is
94
95
appended then we create labels for each category to be used when the
95
96
CPT is plotted. The *label* may be a comma-separated list of category
96
97
names (you can skip a category by not giving a name), or give
97
- *start*\[**-**] , where we automatically build monotonically increasing
98
- labels from *start* (a single letter or an integer). Append **-** to
99
- build ranges *start*-*start+1* instead.
98
+ *start*, where we automatically build monotonically increasing
99
+ labels from *start* (a single letter or an integer). Additionally
100
+ append **-** to build ranges *start*-*start+1* as labels instead.
100
101
series : list or str
101
- [*min/max/inc*\[**+b**\|\ **l**\|\ **n**]\|\ *file*\|\ *list*].
102
+ [*min/max/inc*\ [**+b**\|\ **l**\|\ **n**]\|\ *file*\|\ *list*].
102
103
Define the range of the new CPT by giving the lowest and highest
103
104
z-value (and optionally an interval). If this is not given, the
104
105
existing range in the master CPT will be used intact. The values
105
- produced defines the color slice boundaries. If **+n** is used it
106
+ produced defines the color slice boundaries. If **+n** is used it
106
107
refers to the number of such boundaries and not the number of slices.
107
108
For details on array creation, see
108
109
:gmt-docs:`makecpt.html#generate-1d-array`.
109
110
truncate : list or str
110
111
*zlow/zhigh*.
111
112
Truncate the incoming CPT so that the lowest and highest z-levels are
112
113
to *zlow* and *zhigh*. If one of these equal NaN then we leave that
113
- end of the CPT alone. The truncation takes place before any
114
- resampling. See
115
- also :gmt-docs:`cookbook/features.html#manipulating-cpts`.
114
+ end of the CPT alone. The truncation takes place before any resampling.
115
+ See also :gmt-docs:`cookbook/features.html#manipulating-cpts`.
116
116
output : str
117
117
Optional. The file name with extension .cpt to store the generated CPT
118
118
file. If not given or ``False`` [Default], saves the CPT as the current
119
119
CPT of the session, figure, subplot, panel, or inset depending on which
120
120
level :func:`pygmt.makecpt` is called.
121
121
reverse : str
122
- Set this to True or **c** [Default] to reverse the sense of color
123
- progression in the master CPT. Set this to z to reverse the sign of
124
- z-values in the color table. Note that this change of z-direction
122
+ Set this to `` True`` or **c** [Default] to reverse the sense of color
123
+ progression in the master CPT. Set this to **z** to reverse the sign
124
+ of z-values in the color table. Note that this change of z-direction
125
125
happens before ``truncate`` and ``series`` values are used so the
126
- latter must be compatible with the changed *z* -range. See also
126
+ latter must be compatible with the changed z -range. See also
127
127
:gmt-docs:`cookbook/features.html#manipulating-cpts`.
128
128
overrule_bg : str
129
129
Overrule background, foreground, and NaN colors specified in the master
0 commit comments