Merge branch 'data_kind/doctest' into refactor/data_kind

Author: seisman

pygmt/helpers/utils.py

@@ -217,10 +217,10 @@ def data_kind(  # noqa: PLR0911
     Parameters
     ----------
     data
-        The data that is provided to a module.
+        The data to be passed to a GMT module.
     required
-        If the data is required or not. Set to ``False`` when dealing with optional
-        virtual files.
+        Whether 'data' is required. Set to ``False`` when dealing with optional virtual
+        files.
 
     Returns
     -------
@@ -268,7 +268,7 @@ def data_kind(  # noqa: PLR0911
     ['file', 'file']
     >>> data_kind(data=Path("file.txt"))
     'file'
-    >>> data_kind(data=(Path("file1.txt", "file2.txt")))
+    >>> data_kind(data=(Path("file1.txt"), Path("file2.txt")))
     'file'
 
     The "grid" kind:

pygmt/tests/test_grdtrack.py

@@ -135,7 +135,7 @@ def test_grdtrack_wrong_kind_of_points_input(dataarray, dataframe):
 
 def test_grdtrack_wrong_kind_of_grid_input(dataarray, dataframe):
     """
-    Run grdtrack using grid input that is not as xarray.DataArray (grid) or file.
+    Run grdtrack using grid input that is not an xarray.DataArray or file.
     """
     invalid_grid = dataarray.to_dataset()
     with pytest.raises(GMTInvalidInput):

pygmt/tests/test_x2sys_cross.py

@@ -236,8 +236,8 @@ def test_x2sys_cross_input_two_filenames():
 
 def test_x2sys_cross_invalid_tracks_input_type(tracks):
     """
-    Run x2sys_cross using tracks input that is not a pandas.DataFrame (matrix) or str
-    (file) type, which would raise a GMTInvalidInput error.
+    Run x2sys_cross using tracks input that is not a pandas.DataFrame or str type,
+    which would raise a GMTInvalidInput error.
     """
     invalid_tracks = tracks[0].to_xarray().z
     with pytest.raises(GMTInvalidInput):