Use table-classes filler in docstring description

Author: weiji14

pygmt/helpers/decorators.py

@@ -232,6 +232,11 @@ def fmt_docstring(module_func):
         "xarray.Dataset"
         # "geopandas.GeoDataFrame"
     )
+    filler_text["table-classes"] = (
+        ":class:`numpy.ndarray`, a :class:`pandas.DataFrame`, or an \n"
+        "    :class:`xarray.Dataset` made up of 1D :class:`xarray.DataArray` \n"
+        "    data variables containing the tabular data."
+    )
 
     for marker, text in COMMON_OPTIONS.items():
         # Remove the indentation and the first line break from the multiline

pygmt/helpers/utils.py

@@ -32,9 +32,8 @@ def data_kind(data, x=None, y=None, z=None):
     ----------
     data : str or xarray.DataArray or {table-like} or None
         Pass in either a file name to an ASCII data table, an
-        :class:`xarray.DataArray`, a 1D/2D :class:`numpy.ndarray`, a
-        :class:`pandas.DataFrame`, or an :class:`xarray.Dataset` made up of 1D
-        :class:`xarray.DataArray` data variables.
+        :class:`xarray.DataArray`, a 1D/2D
+        {table-classes}.
     x/y : 1d arrays or None
         x and y columns as numpy arrays.
     z : 1d array or None

pygmt/src/grdtrack.py

@@ -37,9 +37,7 @@ def grdtrack(points, grid, newcolname=None, outfile=None, **kwargs):
     ----------
     points : str or {table-like}
         Pass in either a file name to an ASCII data table, a 2D
-        :class:`numpy.ndarray`, a :class:`pandas.DataFrame`, or an
-        :class:`xarray.Dataset` made up of 1D :class:`xarray.DataArray` data
-        variables containing the tabular data.
+        {table-classes}.
 
     grid : xarray.DataArray or str
         Gridded array from which to sample values from, or a filename (netcdf

pygmt/src/histogram.py

@@ -46,9 +46,8 @@ def histogram(self, table, **kwargs):
     ----------
     table : str or list or {table-like}
         Pass in either a file name to an ASCII data table, a Python list, a 2D
-        :class:`numpy.ndarray`, a :class:`pandas.DataFrame`, or an
-        :class:`xarray.Dataset` made up of 1D :class:`xarray.DataArray` data
-        variables containing the tabular data. This is a required argument.
+        {table-classes}.
+        This is a required argument.
     {J}
     {R}
     {B}

pygmt/src/info.py

@@ -48,9 +48,7 @@ def info(table, **kwargs):
     ----------
     table : str or {table-like}
         Pass in either a file name to an ASCII data table, a 1D/2D
-        :class:`numpy.ndarray`, a :class:`pandas.DataFrame`, or an
-        :class:`xarray.Dataset` made up of 1D :class:`xarray.DataArray` data
-        variables containing the tabular data.
+        {table-classes}.
     per_column : bool
         Report the min/max values per column in separate columns.
     spacing : str

pygmt/src/plot.py

@@ -78,10 +78,9 @@ def plot(self, x=None, y=None, data=None, size=None, direction=None, **kwargs):
         data points
     data : str or {table-like}
         Pass in either a file name to an ASCII data table, a 2D
-        :class:`numpy.ndarray`, a :class:`pandas.DataFrame`, or an
-        :class:`xarray.Dataset` made up of 1D :class:`xarray.DataArray` data
-        variables containing the tabular data. Use parameter ``columns`` to
-        choose which columns are x, y, color, and size, respectively.
+        {table-classes}.
+        Use parameter ``columns`` to choose which columns are x, y, color, and
+        size, respectively.
     size : 1d array
         The size of the data points in units specified using ``style``.
         Only valid if using ``x``/``y``.

pygmt/src/plot3d.py

@@ -80,10 +80,9 @@ def plot3d(
         the data points
     data : str or {table-like}
         Pass in either a file name to an ASCII data table, a 2D
-        :class:`numpy.ndarray`, a :class:`pandas.DataFrame`, or an
-        :class:`xarray.Dataset` made up of 1D :class:`xarray.DataArray` data
-        variables containing the tabular data. Use parameter ``columns`` to
-        choose which columns are x, y, z, color, and size, respectively.
+        {table-classes}.
+        Use parameter ``columns`` to choose which columns are x, y, z, color,
+        and size, respectively.
     size : 1d array
         The size of the data points in units specified in ``style``.
         Only valid if using ``x``/``y``/``z``.

pygmt/src/rose.py

@@ -61,13 +61,11 @@ def rose(self, length=None, azimuth=None, data=None, **kwargs):
 
     data : str or {table-like}
         Pass in either a file name to an ASCII data table, a 2D
-        :class:`numpy.ndarray`, a :class:`pandas.DataFrame`, or an
-        :class:`xarray.Dataset` made up of 1D :class:`xarray.DataArray` data
-        variables containing the tabular data. Use option ``columns`` to choose
-        which columns are length and azimuth, respectively. If a file with only
-        azimuths is given, use ``columns`` to indicate the single column with
-        azimuths; then all lengths are set to unity (see ``scale = 'u'`` to set
-        actual lengths to unity as well).
+        {table-classes}.
+        Use option ``columns`` to choose which columns are length and azimuth,
+        respectively. If a file with only azimuths is given, use ``columns`` to
+        indicate the single column with azimuths; then all lengths are set to
+        unity (see ``scale = 'u'`` to set actual lengths to unity as well).
 
     orientation : bool
         Specifies that the input data are orientation data (i.e., have a

pygmt/src/velo.py

@@ -55,10 +55,9 @@ def velo(self, data=None, **kwargs):
     ----------
     data : str or {table-like}
         Pass in either a file name to an ASCII data table, a 2D
-        :class:`numpy.ndarray`, a :class:`pandas.DataFrame`, or an
-        :class:`xarray.Dataset` made up of 1D :class:`xarray.DataArray` data
-        variables containing the tabular data. Note that text columns are only
-        supported with file or pandas DataFrame inputs.
+        {table-classes}.
+        Note that text columns are only supported with file or pandas DataFrame
+        inputs.
 
     spec: str
         Selects the meaning of the columns in the data file and the figure to

pygmt/src/wiggle.py

@@ -43,10 +43,9 @@ def wiggle(self, x=None, y=None, z=None, data=None, **kwargs):
         The arrays of x and y coordinates and z data points.
     data : str or {table-like}
         Pass in either a file name to an ASCII data table, a 2D
-        :class:`numpy.ndarray`, a :class:`pandas.DataFrame`, or an
-        :class:`xarray.Dataset` made up of 1D :class:`xarray.DataArray` data
-        variables containing the tabular data. Use parameter ``columns`` to
-        choose which columns are x, y, z, respectively.
+        {table-classes}.
+        Use parameter ``columns`` to choose which columns are x, y, z,
+        respectively.
     {J}
     {R}
     scale : str or float