Merge branch 'main' into doc/clarify-dev-deps

GenericMappingTools · Mar 7, 2022 · 1fc43ec · 1fc43ec
2 parents ab8ac74 + 3a9cce8
commit 1fc43ec
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/pygmt/src/sph2grd.py b/pygmt/src/sph2grd.py
@@ -63,6 +63,15 @@ def sph2grd(data, **kwargs):
         - :class:`xarray.DataArray` if ``outgrid`` is not set
         - None if ``outgrid`` is set (grid output will be stored in file set by
           ``outgrid``)
+
+    Example
+    -------
+    >>> import pygmt  # doctest: +SKIP
+    >>> # Create a new grid from the remote file "EGM96_to_36.txt",
+    >>> # set the grid spacing to 1, and the region to "g"
+    >>> new_grid = pygmt.sph2grd(
+    ...     data="@EGM96_to_36.txt", spacing=1, region="g"
+    ... )  # doctest: +SKIP
     """
     with GMTTempFile(suffix=".nc") as tmpfile:
         with Session() as lib: