Inline examples: Use "longitude" and "latitude" instead of "x" and "y" and add units in comments (#2740)

Author: yvonnefroehlich

pygmt/src/blockm.py

@@ -155,7 +155,7 @@ def blockmean(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
     >>> import pygmt
     >>> # Load a table of ship observations of bathymetry off Baja California
     >>> data = pygmt.datasets.load_sample_data(name="bathymetry")
-    >>> # Calculate block mean values within 5 by 5 minute bins
+    >>> # Calculate block mean values within 5 by 5 arc-minute bins
     >>> data_bmean = pygmt.blockmean(
     ...     data=data, region=[245, 255, 20, 30], spacing="5m"
     ... )
@@ -242,7 +242,7 @@ def blockmedian(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
     >>> import pygmt
     >>> # Load a table of ship observations of bathymetry off Baja California
     >>> data = pygmt.datasets.load_sample_data(name="bathymetry")
-    >>> # Calculate block median values within 5 by 5 minute bins
+    >>> # Calculate block median values within 5 by 5 arc-minute bins
     >>> data_bmedian = pygmt.blockmedian(
     ...     data=data, region=[245, 255, 20, 30], spacing="5m"
     ... )
@@ -329,7 +329,7 @@ def blockmode(data=None, x=None, y=None, z=None, outfile=None, **kwargs):
     >>> import pygmt
     >>> # Load a table of ship observations of bathymetry off Baja California
     >>> data = pygmt.datasets.load_sample_data(name="bathymetry")
-    >>> # Calculate block mode values within 5 by 5 minute bins
+    >>> # Calculate block mode values within 5 by 5 arc-minute bins
     >>> data_bmode = pygmt.blockmode(
     ...     data=data, region=[245, 255, 20, 30], spacing="5m"
     ... )

pygmt/src/grd2xyz.py

@@ -131,8 +131,8 @@ def grd2xyz(grid, output_type="pandas", outfile=None, **kwargs):
     Example
     -------
     >>> import pygmt
-    >>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
-    >>> # and a y-range of 15 to 25
+    >>> # Load a grid of @earth_relief_30m data, with a longitude range of
+    >>> # 10° E to 30° E, and a latitude range of 15° N to 25° N
     >>> grid = pygmt.datasets.load_earth_relief(
     ...     resolution="30m", region=[10, 30, 15, 25]
     ... )

pygmt/src/grdclip.py

@@ -83,8 +83,8 @@ def grdclip(grid, **kwargs):
     Example
     -------
     >>> import pygmt
-    >>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
-    >>> # and a y-range of 15 to 25
+    >>> # Load a grid of @earth_relief_30m data, with a longitude range of
+    >>> # 10° E to 30° E, and a latitude range of 15° N to 25° N
     >>> grid = pygmt.datasets.load_earth_relief(
     ...     resolution="30m", region=[10, 30, 15, 25]
     ... )

pygmt/src/grdcut.py

@@ -93,13 +93,13 @@ def grdcut(grid, **kwargs):
     Example
     -------
     >>> import pygmt
-    >>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
-    >>> # and a y-range of 15 to 25
+    >>> # Load a grid of @earth_relief_30m data, with a longitude range of
+    >>> # 10° E to 30° E, and a latitude range of 15° N to 25° N
     >>> grid = pygmt.datasets.load_earth_relief(
     ...     resolution="30m", region=[10, 30, 15, 25]
     ... )
-    >>> # Create a new grid from an input grid, with an x-range of 12 to 15,
-    >>> # and a y-range of 21 to 24
+    >>> # Create a new grid from an input grid, with a longitude range of
+    >>> # 12° E to 15° E and a latitude range of 21° N to 24° N
     >>> new_grid = pygmt.grdcut(grid=grid, region=[12, 15, 21, 24])
     """
     with GMTTempFile(suffix=".nc") as tmpfile:

pygmt/src/grdgradient.py

@@ -155,8 +155,8 @@ def grdgradient(grid, **kwargs):
     Example
     -------
     >>> import pygmt
-    >>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
-    >>> # and a y-range of 15 to 25
+    >>> # Load a grid of @earth_relief_30m data, with a longitude range of
+    >>> # 10° E to 30° E, and a latitude range of 15° N to 25° N
     >>> grid = pygmt.datasets.load_earth_relief(
     ...     resolution="30m", region=[10, 30, 15, 25]
     ... )

pygmt/src/grdhisteq.py

@@ -296,7 +296,7 @@ def compute_bins(
         -------
         >>> import pygmt
         >>> # Load a grid of @earth_relief_30m data, with a longitude range of
-        >>> # 10°E to 30°E, and a latitude range of 15°N to 25°N
+        >>> # 10° E to 30° E, and a latitude range of 15° N to 25° N
         >>> grid = pygmt.datasets.load_earth_relief(
         ...     resolution="30m", region=[10, 30, 15, 25]
         ... )

pygmt/src/grdlandmask.py

@@ -97,8 +97,8 @@ def grdlandmask(**kwargs):
     Example
     -------
     >>> import pygmt
-    >>> # Create a landmask grid with an x-range of 125 to 130,
-    >>> # and a y-range of 30 to 35
+    >>> # Create a landmask grid with a longitude range of 125° E to 130° E, a
+    >>> # latitude range of 30° N to 35° N, and a grid spacing of 1 arc-degree
     >>> landmask = pygmt.grdlandmask(spacing=1, region=[125, 130, 30, 35])
     """
     if kwargs.get("I") is None or kwargs.get("R") is None:

pygmt/src/grdproject.py

@@ -104,8 +104,8 @@ def grdproject(grid, **kwargs):
     Example
     -------
     >>> import pygmt
-    >>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
-    >>> # and a y-range of 15 to 25
+    >>> # Load a grid of @earth_relief_30m data, with a longitude range of
+    >>> # 10° E to 30° E, and a latitude range of 15° N to 25° N
     >>> grid = pygmt.datasets.load_earth_relief(
     ...     resolution="30m", region=[10, 30, 15, 25]
     ... )

pygmt/src/grdsample.py

@@ -81,13 +81,13 @@ def grdsample(grid, **kwargs):
     Example
     -------
     >>> import pygmt
-    >>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
-    >>> # and a y-range of 15 to 25
+    >>> # Load a grid of @earth_relief_30m data, with a longitude range of
+    >>> # 10° E to 30° E, and a latitude range of 15° N to 25° N
     >>> grid = pygmt.datasets.load_earth_relief(
     ...     resolution="30m", region=[10, 30, 15, 25]
     ... )
     >>> # Create a new grid from an input grid, change the registration,
-    >>> # and set both x- and y-spacing to 0.5 degrees
+    >>> # and set both x- and y-spacing to 0.5 arc-degrees
     >>> new_grid = pygmt.grdsample(
     ...     grid=grid, translate=True, spacing=[0.5, 0.5]
     ... )

pygmt/src/grdtrack.py

@@ -270,8 +270,8 @@ def grdtrack(grid, points=None, newcolname=None, outfile=None, **kwargs):
     Example
     -------
     >>> import pygmt
-    >>> # Load a grid of @earth_relief_30m data, with an x-range of -118 to
-    >>> # -107, and a y-range of -49 to -42
+    >>> # Load a grid of @earth_relief_30m data, with a longitude range of
+    >>> # -118° E to -107° E, and a latitude range of -49° N to -42° N
     >>> grid = pygmt.datasets.load_earth_relief(
     ...     resolution="30m", region=[-118, -107, -49, -42]
     ... )