Skip to content

Fix incorrect reST syntax in the data_kind function #3795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 9, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading