From 6225cc34d856c70f30bad202c45f825d55337a8b Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 1 Apr 2024 14:14:11 +0800 Subject: [PATCH] Improve the docstrings of the outgrid parameter --- pygmt/helpers/decorators.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index 28041911d23..16617cd00f5 100644 --- 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*].