Update docstring placeholders to the string.Template syntax

Author: seisman

pygmt/src/basemap.py

@@ -58,12 +58,12 @@ def basemap(
 
     Parameters
     ----------
-    {projection}
+    $projection
     zscale/zsize
         Set z-axis scaling or z-axis size.
-    {region}
+    $region
         *Required if this is the first plot command.*
-    {frame}
+    $frame
     map_scale : str
         [**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
         **+w**\ *length*.
@@ -92,11 +92,11 @@ def basemap(
     compass : str
         Draw a map magnetic rose on the map at the location defined by the
         reference and anchor points.
-    {verbose}
-    {panel}
-    {coltypes}
-    {perspective}
-    {transparency}
+    $verbose
+    $panel
+    $coltypes
+    $perspective
+    $transparency
     """
     self._activate_figure()
 

pygmt/src/binstats.py

@@ -76,7 +76,7 @@ def binstats(
     ----------
     data
         A file name of an ASCII data table or a 2-D {table-classes}.
-    {outgrid}
+    $outgrid
     statistic
         Choose the statistic that will be computed per node based on the points that are
         within *radius* distance of the node. Select one of:
@@ -115,14 +115,14 @@ def binstats(
         computed while the count will be the sum of the weights instead of
         number of points. If the weights are actually uncertainties
         (one sigma) then append **+s** and weight = 1/sigma.
-    {spacing}
-    {region}
-    {verbose}
-    {aspatial}
-    {binary}
-    {header}
-    {incols}
-    {registration}
+    $spacing
+    $region
+    $verbose
+    $aspatial
+    $binary
+    $header
+    $incols
+    $registration
 
     Returns
     -------

pygmt/src/blockm.py

@@ -126,9 +126,9 @@ def blockmean(
         {table-classes}.
     x/y/z : 1-D arrays
         Arrays of x and y coordinates and values z of the data points.
-    {output_type}
-    {outfile}
-    {spacing}
+    $output_type
+    $outfile
+    $spacing
     summary : str
         [**m**\|\ **n**\|\ **s**\|\ **w**].
         Type of summary values calculated by blockmean.
@@ -137,18 +137,18 @@ def blockmean(
         - **n**: report the number of input points inside each block
         - **s**: report the sum of all z-values inside a block
         - **w**: report the sum of weights
-    {region}
-    {verbose}
-    {aspatial}
-    {binary}
-    {nodata}
-    {find}
-    {incols}
-    {coltypes}
-    {header}
-    {outcols}
-    {registration}
-    {wrap}
+    $region
+    $verbose
+    $aspatial
+    $binary
+    $nodata
+    $find
+    $incols
+    $coltypes
+    $header
+    $outcols
+    $registration
+    $wrap
 
     Returns
     -------
@@ -241,21 +241,21 @@ def blockmedian(
         {table-classes}.
     x/y/z : 1-D arrays
         Arrays of x and y coordinates and values z of the data points.
-    {output_type}
-    {outfile}
-    {spacing}
-    {region}
-    {verbose}
-    {aspatial}
-    {binary}
-    {nodata}
-    {find}
-    {coltypes}
-    {header}
-    {incols}
-    {outcols}
-    {registration}
-    {wrap}
+    $output_type
+    $outfile
+    $spacing
+    $region
+    $verbose
+    $aspatial
+    $binary
+    $nodata
+    $find
+    $coltypes
+    $header
+    $incols
+    $outcols
+    $registration
+    $wrap
 
     Returns
     -------
@@ -350,21 +350,21 @@ def blockmode(
         {table-classes}.
     x/y/z : 1-D arrays
         Arrays of x and y coordinates and values z of the data points.
-    {output_type}
-    {outfile}
-    {spacing}
-    {region}
-    {verbose}
-    {aspatial}
-    {binary}
-    {nodata}
-    {find}
-    {coltypes}
-    {header}
-    {incols}
-    {outcols}
-    {registration}
-    {wrap}
+    $output_type
+    $outfile
+    $spacing
+    $region
+    $verbose
+    $aspatial
+    $binary
+    $nodata
+    $find
+    $coltypes
+    $header
+    $incols
+    $outcols
+    $registration
+    $wrap
 
     Returns
     -------

pygmt/src/coast.py

@@ -79,11 +79,11 @@ def coast(
 
     Parameters
     ----------
-    {projection}
-    {region}
+    $projection
+    $region
         *Required if this is the first plot command.*
-    {area_thresh}
-    {frame}
+    $area_thresh
+    $frame
     lakes : str or list
         *fill*\ [**+l**\|\ **+r**].
         Set the shade, color, or pattern for lakes and river-lakes. The
@@ -172,10 +172,10 @@ def coast(
         to any of the continent codes (e.g. ``"=EU"`` for Europe). Append
         **+p**\ *pen* to draw polygon outlines [Default is no outline] and
         **+g**\ *fill* to fill them [Default is no fill].
-    {panel}
-    {perspective}
-    {transparency}
-    {verbose}
+    $panel
+    $perspective
+    $transparency
+    $verbose
 
     Example
     -------

pygmt/src/colorbar.py

@@ -71,7 +71,7 @@ def colorbar(
     ----------
     frame : str or list
         Set colorbar boundary frame, labels, and axes attributes.
-    {cmap}
+    $cmap
     position : str
         [**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
         [**+w**\ *length*\ [/\ *width*]]\ [**+e**\ [**b**\|\ **f**][*length*]]\
@@ -135,10 +135,10 @@ def colorbar(
         may be in plot distance units or given as relative fractions and will
         be automatically scaled so that the sum of the widths equals the
         requested colorbar length.
-    {verbose}
-    {panel}
-    {perspective}
-    {transparency}
+    $verbose
+    $panel
+    $perspective
+    $transparency
 
     Example
     -------

pygmt/src/contour.py

@@ -79,8 +79,8 @@ def contour(  # noqa: PLR0913
         {table-classes}.
     x/y/z : 1-D arrays
         Arrays of x and y coordinates and values z of the data points.
-    {projection}
-    {region}
+    $projection
+    $region
     annotation : float, list, or str
         Specify or disable annotated contour levels, modifies annotated
         contours specified in ``levels``.
@@ -91,7 +91,7 @@ def contour(  # noqa: PLR0913
         - Adjust the appearance by appending different modifiers, e.g.,
           ``"annot_int+f10p+gred"`` gives annotations with a font size of 10 points and
           a red filled box. For all available modifiers see :gmt-docs:`contour.html#a`.
-    {frame}
+    $frame
     levels : float, list, or str
         Specify the contour lines to generate.
 
@@ -140,16 +140,16 @@ def contour(  # noqa: PLR0913
         to be of the format [*annotcontlabel*][/*contlabel*]. If either
         label contains a slash (/) character then use ``|`` as the
         separator for the two labels instead.
-    {verbose}
-    {binary}
-    {panel}
-    {nodata}
-    {find}
-    {coltypes}
-    {header}
-    {incols}
-    {perspective}
-    {transparency}
+    $verbose
+    $binary
+    $panel
+    $nodata
+    $find
+    $coltypes
+    $header
+    $incols
+    $perspective
+    $transparency
     """
     self._activate_figure()
 

pygmt/src/dimfilter.py

@@ -53,8 +53,8 @@ def dimfilter(
 
     Parameters
     ----------
-    {grid}
-    {outgrid}
+    $grid
+    $outgrid
     distance : int or str
         Distance flag tells how grid (x,y) relates to filter width, as follows:
 
@@ -111,7 +111,7 @@ def dimfilter(
     region : str or list
         [*xmin*, *xmax*, *ymin*, *ymax*].
         Define the region of the output points [Default is the same as the input].
-    {verbose}
+    $verbose
 
     Returns
     -------

pygmt/src/filter1d.py

@@ -46,8 +46,8 @@ def filter1d(
 
     Parameters
     ----------
-    {output_type}
-    {outfile}
+    $output_type
+    $outfile
     filter_type : str
         **type**\ *width*\ [**+h**].
         Set the filter **type**. Choose among convolution and non-convolution

pygmt/src/grd2cpt.py

@@ -96,7 +96,7 @@ def grd2cpt(
 
     Parameters
     ----------
-    {grid}
+    $grid
     transparency : float or str
         Set a constant level of transparency (0-100) for all color slices. Append **+a**
         to also affect the foreground, background, and NaN colors [Default is no
@@ -182,7 +182,7 @@ def grd2cpt(
         Produce a wrapped (cyclic) color table that endlessly repeats its
         range. Note that ``cyclic=True`` cannot be set together with
         ``categorical=True``.
-    {verbose}
+    $verbose
 
     Example
     -------

pygmt/src/grd2xyz.py

@@ -59,17 +59,17 @@ def grd2xyz(
 
     Parameters
     ----------
-    {grid}
-    {output_type}
-    {outfile}
+    $grid
+    $output_type
+    $outfile
     cstyle : str
         [**f**\|\ **i**].
         Replace the x- and y-coordinates on output with the corresponding
         column and row numbers. These start at 0 (C-style counting); append
         **f** to start at 1 (Fortran-style counting). Alternatively, append
         **i** to write just the two columns *index* and *z*, where *index*
         is the 1-D indexing that GMT uses when referring to grid nodes.
-    {region}
+    $region
         Adding ``region`` will select a subsection of the grid. If this
         subsection exceeds the boundaries of the grid, only the common region
         will be output.
@@ -84,7 +84,7 @@ def grd2xyz(
         this by appending **+u**\ *unit*. For such grids, the area
         varies with latitude and also sees special cases for
         gridline-registered layouts at sides, corners, and poles.
-    {verbose}
+    $verbose
     convention : str
         [*flags*].
         Write a 1-column ASCII [or binary] table. Output will be organized
@@ -115,12 +115,12 @@ def grd2xyz(
         - **d**: 8-byte floating point double precision
 
         Default format is scanline orientation of ASCII numbers: **TLa**.
-    {binary}
-    {nodata}
-    {coltypes}
-    {header}
-    {outcols}
-    {skiprows}
+    $binary
+    $nodata
+    $coltypes
+    $header
+    $outcols
+    $skiprows
 
     Returns
     -------