Update {aliases} to $aliases and {table-classes} to $table_classes

Author: seisman

pygmt/helpers/decorators.py

@@ -407,11 +407,11 @@ def fmt_docstring(module_func):
     ...     ----------
     ...     data
     ...         Pass in either a file name to an ASCII data table, a 2-D
-    ...         {table-classes}.
-    ...     {region}
-    ...     {projection}
+    ...         $table_classes.
+    ...     $region
+    ...     $projection
     ...
-    ...     {aliases}
+    ...     $aliases
     ...     '''
     ...     pass
     >>> print(gmtinfo.__doc__)
@@ -453,7 +453,7 @@ def fmt_docstring(module_func):
             aliases.append(f"   - {arg} = {alias}")
         filler_text["aliases"] = "\n".join(aliases)
 
-    filler_text["table-classes"] = (
+    filler_text["table_classes"] = (
         ":class:`numpy.ndarray`, a :class:`pandas.DataFrame`, an\n"
         "    :class:`xarray.Dataset` made up of 1-D :class:`xarray.DataArray`\n"
         "    data variables, or a :class:`geopandas.GeoDataFrame` containing the\n"

pygmt/src/basemap.py

@@ -45,7 +45,7 @@ def basemap(
 
     Full GMT docs at :gmt-docs:`basemap.html`.
 
-    {aliases}
+    $aliases
        - B = frame
        - J = projection
        - Jz = zscale

pygmt/src/binstats.py

@@ -66,7 +66,7 @@ def binstats(
 
     Full GMT docs at :gmt-docs:`gmtbinstats.html`.
 
-    {aliases}
+    $aliases
        - C = statistic
        - R = region
        - V = verbose
@@ -75,7 +75,7 @@ def binstats(
     Parameters
     ----------
     data
-        A file name of an ASCII data table or a 2-D {table-classes}.
+        A file name of an ASCII data table or a 2-D $table_classes.
     $outgrid
     statistic
         Choose the statistic that will be computed per node based on the points that are

pygmt/src/blockm.py

@@ -113,7 +113,7 @@ def blockmean(
 
     Full GMT docs at :gmt-docs:`blockmean.html`.
 
-    {aliases}
+    $aliases
        - R = region
        - V = verbose
        - r = registration
@@ -123,7 +123,7 @@ def blockmean(
     data
         Pass in (x, y, z) or (longitude, latitude, elevation) values by
         providing a file name to an ASCII data table, a 2-D
-        {table-classes}.
+        $table_classes.
     x/y/z : 1-D arrays
         Arrays of x and y coordinates and values z of the data points.
     $output_type
@@ -228,7 +228,7 @@ def blockmedian(
 
     Full GMT docs at :gmt-docs:`blockmedian.html`.
 
-    {aliases}
+    $aliases
        - R = region
        - V = verbose
        - r = registration
@@ -238,7 +238,7 @@ def blockmedian(
     data
         Pass in (x, y, z) or (longitude, latitude, elevation) values by
         providing a file name to an ASCII data table, a 2-D
-        {table-classes}.
+        $table_classes.
     x/y/z : 1-D arrays
         Arrays of x and y coordinates and values z of the data points.
     $output_type
@@ -337,7 +337,7 @@ def blockmode(
 
     Full GMT docs at :gmt-docs:`blockmode.html`.
 
-    {aliases}
+    $aliases
        - R = region
        - V = verbose
        - r = registration
@@ -347,7 +347,7 @@ def blockmode(
     data
         Pass in (x, y, z) or (longitude, latitude, elevation) values by
         providing a file name to an ASCII data table, a 2-D
-        {table-classes}.
+        $table_classes.
     x/y/z : 1-D arrays
         Arrays of x and y coordinates and values z of the data points.
     $output_type

pygmt/src/coast.py

@@ -66,7 +66,7 @@ def coast(
 
     Full GMT docs at :gmt-docs:`coast.html`.
 
-    {aliases}
+    $aliases
        - B = frame
        - D = resolution
        - F = box

pygmt/src/colorbar.py

@@ -56,7 +56,7 @@ def colorbar(
 
     Full GMT docs at :gmt-docs:`colorbar.html`.
 
-    {aliases}
+    $aliases
        - B = frame
        - F = box
        - I = shading

pygmt/src/contour.py

@@ -61,7 +61,7 @@ def contour(  # noqa: PLR0913
 
     Full GMT docs at :gmt-docs:`contour.html`.
 
-    {aliases}
+    $aliases
        - B = frame
        - J = projection
        - N = no_clip
@@ -76,7 +76,7 @@ def contour(  # noqa: PLR0913
     data
         Pass in (x, y, z) or (longitude, latitude, elevation) values by
         providing a file name to an ASCII data table, a 2-D
-        {table-classes}.
+        $table_classes.
     x/y/z : 1-D arrays
         Arrays of x and y coordinates and values z of the data points.
     $projection

pygmt/src/dimfilter.py

@@ -47,7 +47,7 @@ def dimfilter(
 
     Full GMT docs at :gmt-docs:`dimfilter.html`.
 
-    {aliases}
+    $aliases
        - R = region
        - V = verbose
 

pygmt/src/filter1d.py

@@ -41,7 +41,7 @@ def filter1d(
 
     Full GMT docs at :gmt-docs:`filter1d.html`.
 
-    {aliases}
+    $aliases
        - V = verbose
 
     Parameters

pygmt/src/grd2cpt.py

@@ -85,7 +85,7 @@ def grd2cpt(
 
     Full GMT docs at :gmt-docs:`grd2cpt.html`.
 
-    {aliases}
+    $aliases
        - G = truncate
        - M = overrule_bg
        - N = no_bg