Skip to content

Commit d8c816a

Browse files
Figure.meca: Fix typos in docs (#2197)
1 parent ed3ba86 commit d8c816a

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

pygmt/src/meca.py

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ def meca(
116116
117117
``spec`` can be specified in either of the following types:
118118
119-
- ``str``: a file name containing focal mechanism parameters as
120-
columns. The meanings of each column is:
119+
- *str*: a file name containing focal mechanism parameters as
120+
columns. The meaning of each column is:
121121
122122
- Columns 1 and 2: event longitude and latitude
123123
- Column 3: event depth (in km)
@@ -128,13 +128,13 @@ def meca(
128128
beachball. Using ``0 0`` will plot the beachball at the longitude,
129129
latitude given in columns 1 and 2. [optional and requires
130130
``offset=True`` to take effect].
131-
- Text string to appear near the beach ball [optional].
131+
- Text string to appear near the beachball [optional].
132132
133-
- **1D array**: focal mechanism parameters of a single event.
133+
- *1D array*: focal mechanism parameters of a single event.
134134
The meanings of columns are the same as above.
135-
- **2D array**: focal mechanim parameters of multiple events.
135+
- *2D array*: focal mechanim parameters of multiple events.
136136
The meanings of columns are the same as above.
137-
- dict or pd.DataFrame: The dict keys or pd.DataFrame column names
137+
- *dict or pd.DataFrame*: The dict keys or pd.DataFrame column names
138138
determine the focal mechanims convention. For different conventions,
139139
the following combination of keys are allowed:
140140
@@ -153,9 +153,9 @@ def meca(
153153
``latitude``, ``longitude``, ``depth``, ``plot_longitude``,
154154
``plot_latitude``, and/or ``event_name``.
155155
156-
For ``spec`` in either a str, a 1D array or a 2D array, the
156+
If ``spec`` is either a str, a 1D array or a 2D array, the
157157
``convention`` parameter is required so we know how to interpret the
158-
columns. For ``spec`` in a dict or a pd.DataFrame, ``convention`` is
158+
columns. If ``spec`` is a dict or a pd.DataFrame, ``convention`` is
159159
not needed and is ignored if specified.
160160
161161
scale: str
@@ -164,11 +164,12 @@ def meca(
164164
magnitude = 5 (i.e. scalar seismic moment M0 = 4.0E23 dynes-cm).
165165
convention: str
166166
Focal mechanism convention. Choose from:
167+
167168
- ``"aki"`` (Aki & Richards)
168169
- ``"gcmt"`` (global CMT)
169170
- ``"mt"`` (seismic moment tensor)
170171
- ``"partial"`` (partial focal mechanism)
171-
- ``"principal_axis"`` (principal axis).
172+
- ``"principal_axis"`` (principal axis)
172173
173174
Ignored if ``spec`` is a dictionary or pd.DataFrame.
174175
component: str
@@ -199,7 +200,7 @@ def meca(
199200
as the number of events. Will override the ``plot_latitude`` values in
200201
``spec`` if ``spec`` is a dict or pd.DataFrame.
201202
event_name : str or list of str, or 1d numpy array
202-
Text strings (e.g., event names) to appear near the beach ball. List
203+
Text strings (e.g., event names) to appear near the beachball. List
203204
must be the same length as the number of events. Will override the
204205
``event_name`` values in ``spec`` if ``spec`` is a dict or
205206
pd.DataFrame.

0 commit comments

Comments
 (0)