docs: Use consistent description for the 'outgrid' parameter (#2874)

Author: seisman

pygmt/helpers/decorators.py

@@ -253,6 +253,11 @@
               input and skip trailing text. **Note**: If ``incols`` is also
               used then the columns given to ``outcols`` correspond to the
               order after the ``incols`` selection has taken place.""",
+    "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.""",
     "panel": r"""
         panel : bool, int, or list
             [*row,col*\|\ *index*].

pygmt/src/binstats.py

@@ -51,9 +51,7 @@ def binstats(data, **kwargs):
     data : str, {table-like}
         A file name of an ASCII data table or a 2-D
         {table-classes}.
-    outgrid : str or None
-        The name of the output netCDF file with extension .nc to store the grid
-        in.
+    {outgrid}
     statistic : str
         **a**\|\ **d**\|\ **g**\|\ **i**\|\ **l**\|\ **L**\|\ **m**\|\ **n**\
         \|\ **o**\|\ **p**\|\ **q**\ [*quant*]\|\ **r**\|\ **s**\|\ **u**\

pygmt/src/dimfilter.py

@@ -54,9 +54,7 @@ def dimfilter(grid, **kwargs):
     Parameters
     ----------
     {grid}
-    outgrid : str or None
-        The name of the output netCDF file with extension .nc to store the grid
-        in.
+    {outgrid}
     distance : int or str
         Distance flag tells how grid (x,y) relates to filter width, as follows:
 

pygmt/src/grdclip.py

@@ -51,9 +51,7 @@ def grdclip(grid, **kwargs):
     Parameters
     ----------
     {grid}
-    outgrid : str or None
-        The name of the output netCDF file with extension .nc to store the grid
-        in.
+    {outgrid}
     {region}
     above : str or list
         [*high*, *above*].

pygmt/src/grdcut.py

@@ -47,9 +47,7 @@ def grdcut(grid, **kwargs):
     Parameters
     ----------
     {grid}
-    outgrid : str or None
-        The name of the output netCDF file with extension .nc to store the grid
-        in.
+    {outgrid}
     {projection}
     {region}
     extend : bool or float

pygmt/src/grdfill.py

@@ -41,9 +41,7 @@ def grdfill(grid, **kwargs):
     Parameters
     ----------
     {grid}
-    outgrid : str or None
-        The name of the output netCDF file with extension .nc to store the grid
-        in.
+    {outgrid}
     mode : str
         Specify the hole-filling algorithm to use.  Choose from **c** for
         constant fill and append the constant value, **n** for nearest

pygmt/src/grdfilter.py

@@ -49,9 +49,7 @@ def grdfilter(grid, **kwargs):
     Parameters
     ----------
     {grid}
-    outgrid : str or None
-        The name of the output netCDF file with extension .nc to store the grid
-        in.
+    {outgrid}
     filter : str
         **b**\|\ **c**\|\ **g**\|\ **o**\|\ **m**\|\ **p**\|\ **h**\ *width*\
         [/*width2*\][*modifiers*].

pygmt/src/grdgradient.py

@@ -46,9 +46,7 @@ def grdgradient(grid, **kwargs):
     Parameters
     ----------
     {grid}
-    outgrid : str or None
-        The name of the output netCDF file with extension .nc to store the grid
-        in.
+    {outgrid}
     azimuth : float, str, or list
         *azim*\ [/*azim2*].
         Azimuthal direction for a directional derivative; *azim* is the

pygmt/src/grdhisteq.py

@@ -76,9 +76,7 @@ def _grdhisteq(grid, output_type, **kwargs):
         Parameters
         ----------
         {grid}
-        outgrid : str or bool or None
-            The name of the output netCDF file with extension .nc to store the
-            grid in.
+        {outgrid}
         outfile : str, bool, or None
             The name of the output ASCII file to store the results of the
             histogram equalization in.
@@ -162,9 +160,7 @@ def equalize_grid(
         Parameters
         ----------
         {grid}
-        outgrid : str or None
-            The name of the output netCDF file with extension .nc to store the
-            grid in.
+        {outgrid}
         divisions : int
             Set the number of divisions of the data range.
         gaussian : bool or int or float

pygmt/src/grdlandmask.py

@@ -45,9 +45,7 @@ def grdlandmask(**kwargs):
 
     Parameters
     ----------
-    outgrid : str or None
-        The name of the output netCDF file with extension .nc to store the grid
-        in.
+    {outgrid}
     {spacing}
     {region}
     {area_thresh}