Apply suggestions from code review

Co-authored-by: Meghan Jones <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>

pygmt/figure.py

@@ -151,8 +151,8 @@ def psconvert(self, **kwargs):
  anti_aliasing : str
  [**g**\|\ **p**\|\ **t**\][**1**\|\ **2**\|\ **4**].
  Set the anti-aliasing options for **g**\ raphics or **t**\ ext.
- Append the size of the subsample box (1, 2, or 4) [4]. Default is
- no anti-aliasing (same as bits = 1).
+ Append the size of the subsample box (1, 2, or 4) [4]. [Default is
+ no anti-aliasing (same as bits = 1)].
  fmt : str
  Sets the output format, where **b** means BMP, **e** means EPS,
  **E** means EPS with PageSize command, **f** means PDF, **F** means
@@ -180,7 +180,7 @@ def savefig(
  Save the figure to a file.
 
  This method implements a matplotlib-like interface for
- :doc:psconvert </psconvert>.
+ :meth:`pygmt.Figure.psconvert`.
 
  Supported formats: PNG (``.png``), JPEG (``.jpg``), PDF (``.pdf``),
  BMP (``.bmp``), TIFF (``.tif``), EPS (``.eps``), and KML (``.kml``).
@@ -202,7 +202,7 @@ def savefig(
  anti_alias: bool
  If True, will use anti aliasing when creating raster images (PNG,
  JPG, TIFF). More specifically, it uses options ``t2, g2`` in
- :doc:psconvert </psconvert>. Ignored if creating vector graphics.
+ :meth:`pygmt.Figure.psconvert`. Ignored if creating vector graphics.
  show: bool
  If True, will open the figure in an external viewer.
  dpi : int

pygmt/src/blockmedian.py

@@ -41,7 +41,7 @@ def blockmedian(table, outfile=None, **kwargs):
  spacing : str
  *xinc*\[\ *unit*\][**+e**\|\ **n**]
  [/*yinc*\ [*unit*][**+e**\|\ **n**]].
- x_inc [and optionally y_inc] is the grid spacing.
+ *xinc* [and optionally *yinc*] is the grid spacing.
 
  region : str or list
  *xmin/xmax/ymin/ymax*\[\ **+r**\][**+u**\ *unit*].

pygmt/src/grdcut.py

@@ -31,7 +31,7 @@ def grdcut(grid, **kwargs):
  r"""
  Extract subregion from a grid.
 
- Produce a new *outgrid* file which is a subregion of *grid*. The
+ Produce a new ``outgrid`` file which is a subregion of ``grid``. The
  subregion is specified with *region*; the specified range must not exceed
  the range of *grid* (but see *extend*). If in doubt, run
  :meth:`pygmt.grdinfo` to check range. Alternatively, define the subregion
@@ -54,7 +54,7 @@ def grdcut(grid, **kwargs):
  {J}
  {R}
  extend : bool or int or float
- Allow grid to be extended if new *region* exceeds existing boundaries.
+ Allow grid to be extended if new ``region`` exceeds existing boundaries.
  Give a value to initialize nodes outside current region.
  circ_subregion : str
  *lon/lat/radius*\[\ *unit*\][**+n**].

pygmt/src/grdfilter.py

@@ -101,7 +101,7 @@ def grdfilter(grid, **kwargs):
  spacing : str
  *xinc*\[\ *unit*\][**+e**\|\ **n**]
  [/*yinc*\ [*unit*][**+e**\|\ **n**]].
- x_inc [and optionally y_inc] is the grid spacing.
+ *xinc* [and optionally *yinc*] is the grid spacing.
  nans : str or float
  **i**\|\ **p**\|\ **r**.
  Determine how NaN-values in the input grid affects the filtered output.

pygmt/src/surface.py

@@ -49,7 +49,7 @@ def surface(x=None, y=None, z=None, data=None, **kwargs):
  spacing : str
  *xinc*\[\ *unit*\][**+e**\|\ **n**]
  [/*yinc*\ [*unit*][**+e**\|\ **n**]].
- x_inc [and optionally y_inc] is the grid spacing.
+ *xinc* [and optionally *yinc*] is the grid spacing.
 
  region : str or list
  *xmin/xmax/ymin/ymax*\[\ **+r**\][**+u**\ *unit*].

pygmt/x2sys.py

@@ -121,7 +121,7 @@ def x2sys_init(tag, **kwargs):
 
  spacing : str or list
  *dx*\[/*dy*\].
- x_inc [and optionally y_inc] is the grid spacing. Append **m** to
+ *dx* [and optionally *dy*] is the grid spacing. Append **m** to
  indicate minutes or **s** to indicate seconds for geographic data.
  These spacings refer to the binning used in the track bin-index data
  base.
@@ -151,7 +151,7 @@ def x2sys_init(tag, **kwargs):
  **t**\|\ **d**\ *gap*.
  Give **t** or **d** and append the corresponding maximum time gap (in
  user units; this is typically seconds [Infinity]), or distance (for
- units, see *units*) gap [Infinity]) allowed between the two data points
+ units, see ``units``) gap [Default is infinity]) allowed between the two data points
  immediately on either side of a crossover. If these limits are exceeded
  then a data gap is assumed and no COE will be determined.