Add inline example for grdcut (#1689)

Example to create a new grid from an input grid using pygmt.grdcut.

Co-authored-by: Meghan Jones <[email protected]>Create a new grid from an input grid

Author: willschlitzer

pygmt/src/grdcut.py

@@ -87,6 +87,20 @@ def grdcut(grid, **kwargs):
         - :class:`xarray.DataArray` if ``outgrid`` is not set
         - None if ``outgrid`` is set (grid output will be stored in file set by
           ``outgrid``)
+
+    Examples
+    --------
+    >>> import pygmt  # doctest: +SKIP
+    >>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
+    >>> # and a y-range of 15 to 25
+    >>> grid = pygmt.datasets.load_earth_relief(
+    ...     resolution="30m", region=[10, 30, 15, 25]
+    ... )  # doctest: +SKIP
+    >>> # Create a new grid from an input grid, with an x-range of 12 to 15,
+    >>> # and a y-range of 21 to 24
+    >>> new_grid = pygmt.grdcut(
+    ...     grid=grid, region=[12, 15, 21, 24]
+    ... )  # doctest: +SKIP
     """
     with GMTTempFile(suffix=".nc") as tmpfile:
         with Session() as lib: