Skip to content

Commit c5435b0

Browse files
committed
Improve the docstrings of the outgrid parameter
1 parent cd2c5d7 commit c5435b0

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

pygmt/helpers/decorators.py

+6-4
Original file line numberDiff line numberDiff line change
@@ -267,10 +267,12 @@
267267
- ``file`` will save the result to the file specified by the ``outfile``
268268
parameter.""",
269269
"outgrid": """
270-
outgrid : str or None
271-
Name of the output netCDF grid file. For writing a specific grid
272-
file format or applying basic data operations to the output grid,
273-
see :gmt-docs:`gmt.html#grd-inout-full` for the available modifiers.""",
270+
outgrid
271+
Name of the output netCDF grid file. If not specified, will return an
272+
:class:`xarray.DataArray` object. For writing a specific grid file format or
273+
applying basic data operations to the output grid, see
274+
:gmt-docs:`gmt.html#grd-inout-full` for the available modifiers.
275+
""",
274276
"panel": r"""
275277
panel : bool, int, or list
276278
[*row,col*\|\ *index*].

0 commit comments

Comments
 (0)