Skip to content

Commit b46274b

Browse files
authored
Fix incorrect reST syntax in the data_kind function (#3795)
1 parent de590b4 commit b46274b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

pygmt/helpers/utils.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -204,8 +204,8 @@ def data_kind(
204204
r"""
205205
Check the kind of data that is provided to a module.
206206
207-
The argument passed to the ``data`` parameter can have any data type. The
208-
following data kinds are recognized and returned as ``kind``:
207+
The argument passed to the ``data`` parameter can have any data type. The following
208+
data kinds are recognized and returned as ``kind``:
209209
210210
- ``"arg"``: ``data`` is ``None`` and ``required=False``, or bool, int, float,
211211
representing an optional argument, used for dealing with optional virtual files
@@ -222,7 +222,7 @@ def data_kind(
222222
(e.g., :class:`numpy.ndarray`)
223223
- ``"vectors"``: any unrecognized data. Common data types include, a
224224
:class:`pandas.DataFrame` object, a dictionary with array-like values, a 1-D/3-D
225-
:class:`numpy.ndarray` object, or array-like objects.
225+
:class:`numpy.ndarray` object, or array-like objects
226226
227227
Parameters
228228
----------
@@ -280,12 +280,12 @@ def data_kind(
280280
>>> data_kind(data=xr.DataArray(np.random.rand(3, 4, 5))) # 3-D xarray.DataArray
281281
'image'
282282
283-
The "stringio"`` kind:
283+
The "stringio" kind:
284284
285285
>>> data_kind(data=io.StringIO("TEXT1\nTEXT23\n"))
286286
'stringio'
287287
288-
The "matrix"`` kind:
288+
The "matrix" kind:
289289
290290
>>> data_kind(data=np.arange(10).reshape((5, 2))) # 2-D numpy.ndarray
291291
'matrix'

0 commit comments

Comments
 (0)