Skip to content

Commit

Permalink
Fix incorrect reST syntax in the data_kind function (#3795)
Browse files Browse the repository at this point in the history
  • Loading branch information
seisman authored Feb 9, 2025
1 parent de590b4 commit b46274b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions pygmt/helpers/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -204,8 +204,8 @@ def data_kind(
r"""
Check the kind of data that is provided to a module.
The argument passed to the ``data`` parameter can have any data type. The
following data kinds are recognized and returned as ``kind``:
The argument passed to the ``data`` parameter can have any data type. The following
data kinds are recognized and returned as ``kind``:
- ``"arg"``: ``data`` is ``None`` and ``required=False``, or bool, int, float,
representing an optional argument, used for dealing with optional virtual files
Expand All @@ -222,7 +222,7 @@ def data_kind(
(e.g., :class:`numpy.ndarray`)
- ``"vectors"``: any unrecognized data. Common data types include, a
:class:`pandas.DataFrame` object, a dictionary with array-like values, a 1-D/3-D
:class:`numpy.ndarray` object, or array-like objects.
:class:`numpy.ndarray` object, or array-like objects
Parameters
----------
Expand Down Expand Up @@ -280,12 +280,12 @@ def data_kind(
>>> data_kind(data=xr.DataArray(np.random.rand(3, 4, 5))) # 3-D xarray.DataArray
'image'
The "stringio"`` kind:
The "stringio" kind:
>>> data_kind(data=io.StringIO("TEXT1\nTEXT23\n"))
'stringio'
The "matrix"`` kind:
The "matrix" kind:
>>> data_kind(data=np.arange(10).reshape((5, 2))) # 2-D numpy.ndarray
'matrix'
Expand Down

0 comments on commit b46274b

Please sign in to comment.