diff --git a/pygmt/src/surface.py b/pygmt/src/surface.py index f871081f3ef..e626d0eec8b 100644 --- a/pygmt/src/surface.py +++ b/pygmt/src/surface.py @@ -14,6 +14,8 @@ ) from pygmt.io import load_dataarray +__doctest_skip__ = ["surface"] + @fmt_docstring @deprecate_parameter("outfile", "outgrid", "v0.5.0", remove_version="v0.7.0") @@ -90,6 +92,16 @@ def surface(data=None, x=None, y=None, z=None, **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 + >>> # Load a sample table of topography + >>> topography = pygmt.datasets.load_sample_data( + ... name="notre_dame_topography" + ... ) + >>> # Perform gridding of topography data + >>> grid = pygmt.surface(data=topography, spacing=1, region=[0, 4, 0, 8]) """ with GMTTempFile(suffix=".nc") as tmpfile: with Session() as lib: