Skip to content

Commit a341f24

Browse files
committed
Rename alias uncertainty_color to uncertaintycolor for parameter E
As per #1190 (comment). Plus re-wrap some paragraphs to 79 characters.
1 parent f949f16 commit a341f24

File tree

2 files changed

+19
-20
lines changed

2 files changed

+19
-20
lines changed

pygmt/src/velo.py

+18-19
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
B="frame",
1515
C="cmap",
1616
D="rescale",
17-
E="uncertainty_color",
17+
E="uncertaintycolor",
1818
G="color",
1919
H="scale",
2020
I="shading",
@@ -39,11 +39,11 @@ def velo(self, data=None, **kwargs):
3939
Plot velocity vectors, crosses, anisotropy bars, and wedges.
4040
4141
Reads data values from files, :class:`numpy.ndarray` or
42-
:class:`pandas.DataFrame` and plots the selected geodesy symbol on a
43-
map. You may choose from velocity vectors and their uncertainties,
44-
rotational wedges and their uncertainties, anisotropy bars, or strain
45-
crosses. Symbol fills or their outlines may be colored based on constant
46-
parameters or via color lookup tables.
42+
:class:`pandas.DataFrame` and plots the selected geodesy symbol on a map.
43+
You may choose from velocity vectors and their uncertainties, rotational
44+
wedges and their uncertainties, anisotropy bars, or strain crosses. Symbol
45+
fills or their outlines may be colored based on constant parameters or via
46+
color lookup tables.
4747
4848
Must provide ``data`` and ``spec``.
4949
@@ -59,10 +59,10 @@ def velo(self, data=None, **kwargs):
5959
are only supported with file or pandas DataFrame inputs.
6060
6161
spec: str
62-
Selects the meaning of the columns in the data file and the figure
63-
to be plotted. In all cases, the scales are in data units per length
64-
unit and sizes are in length units (default length unit is controlled
65-
by :gmt-term:`PROJ_LENGTH_UNIT` unless **c**, **i**, or **p** is
62+
Selects the meaning of the columns in the data file and the figure to
63+
be plotted. In all cases, the scales are in data units per length unit
64+
and sizes are in length units (default length unit is controlled by
65+
:gmt-term:`PROJ_LENGTH_UNIT` unless **c**, **i**, or **p** is
6666
appended).
6767
6868
- **e**\ [*velscale*/]\ *confidence*\ [**+f**\ *font*]
@@ -76,7 +76,7 @@ def velo(self, data=None, **kwargs):
7676
labeling. The arrow will be drawn with the pen attributes specified
7777
by the ``pen`` option and the arrow-head can be colored via
7878
``color``. The ellipse will be filled with the color or shade
79-
specified by the ``uncertainty_color`` option [Default is
79+
specified by the ``uncertaintycolor`` option [Default is
8080
transparent], and its outline will be drawn if ``line`` is selected
8181
using the pen selected (by ``pen`` if not given by ``line``).
8282
Parameters are expected to be in the following columns:
@@ -109,7 +109,7 @@ def velo(self, data=None, **kwargs):
109109
labeling. The arrow will be drawn with the pen attributes specified
110110
by the ``pen`` option and the arrow-head can be colored via
111111
``color``. The ellipse will be filled with the color or shade
112-
specified by the ``uncertainty_color`` option [Default is
112+
specified by the ``uncertaintycolor`` option [Default is
113113
transparent], and its outline will be drawn if ``line`` is selected
114114
using the pen selected (by ``pen`` if not given by ``line``).
115115
Parameters are expected to be in the following columns:
@@ -128,7 +128,7 @@ def velo(self, data=None, **kwargs):
128128
extra column. Rotation values are multiplied by *wedgemag* before
129129
plotting. For example, setting *wedgemag* to 1.e7 works well for
130130
rotations of the order of 100 nanoradians/yr. Use ``color`` to set
131-
the fill color or shade for the wedge, and ``uncertainty_color`` to
131+
the fill color or shade for the wedge, and ``uncertaintycolor`` to
132132
set the color or shade for the uncertainty. Parameters are expected
133133
to be in the following columns:
134134
@@ -138,10 +138,9 @@ def velo(self, data=None, **kwargs):
138138
139139
- **x**\ [*cross_scale*]
140140
141-
Strain crosses. The *cross_scale* sets the size of the cross.
142-
If *cross_scale* is not given then we read it from the data file as
143-
an extra column. Parameters are expected to be in the following
144-
columns:
141+
Strain crosses. The *cross_scale* sets the size of the cross. If
142+
*cross_scale* is not given then we read it from the data file as an
143+
extra column. Parameters are expected to be in the following columns:
145144
146145
- **1**,\ **2**: longitude, latitude of station
147146
- **3**: eps1, the most extensional eigenvalue of strain tensor,
@@ -163,10 +162,10 @@ def velo(self, data=None, **kwargs):
163162
can be used to rescale the uncertainties of velocities (``spec='e'``
164163
and ``spec='r'``) and rotations (``spec='w'``). Can be combined with
165164
the ``confidence`` variable.
166-
uncertainty_color : str
165+
uncertaintycolor : str
167166
Sets the color or shade used for filling uncertainty wedges
168167
(``spec='w'``) or velocity error ellipses (``spec='e'`` or
169-
``spec='r'``). If ``uncertainty_color`` is not specified, the
168+
``spec='r'``). If ``uncertaintycolor`` is not specified, the
170169
uncertainty regions will be transparent. **Note**: Using ``cmap`` and
171170
``zvalue='+e'`` will update the uncertainty fill color based on the
172171
selected measure in ``zvalue`` [magnitude error]. More details at

pygmt/tests/test_velo.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def test_velo_pandas_dataframe(dataframe):
8585
region=[-10, 8, -10, 6],
8686
projection="x0.8c",
8787
pen="0.6p,red",
88-
uncertainty_color="lightblue1",
88+
uncertaintycolor="lightblue1",
8989
line=True,
9090
)
9191
return fig

0 commit comments

Comments
 (0)