Improve the docstrings of the outgrid parameter

GenericMappingTools · Apr 1, 2024 · 6225cc3 · 6225cc3
1 parent 113c5fe
commit 6225cc3
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py
@@ -267,10 +267,12 @@
             - ``file`` will save the result to the file specified by the ``outfile``
               parameter.""",
     "outgrid": """
-        outgrid : str or None
-            Name of the output netCDF grid file. For writing a specific grid
-            file format or applying basic data operations to the output grid,
-            see :gmt-docs:`gmt.html#grd-inout-full` for the available modifiers.""",
+        outgrid
+            Name of the output netCDF grid file. If not specified, will return an
+            :class:`xarray.DataArray` object. For writing a specific grid file format or
+            applying basic data operations to the output grid, see
+            :gmt-docs:`gmt.html#grd-inout-full` for the available modifiers.
+        """,
     "panel": r"""
         panel : bool, int, or list
             [*row,col*\|\ *index*].