diff --git a/pygmt/src/select.py b/pygmt/src/select.py index db37f8da54d..e5ec32844a0 100644 --- a/pygmt/src/select.py +++ b/pygmt/src/select.py @@ -12,6 +12,7 @@ from pygmt.clib import Session from pygmt.helpers import ( build_arg_list, + deprecate_parameter, fmt_docstring, kwargs_to_strings, use_alias, @@ -22,11 +23,12 @@ @fmt_docstring +@deprecate_parameter("gridmask", "mask_grid", "v0.18.0", remove_version="v0.20.0") @use_alias( A="area_thresh", C="dist2pt", F="polygon", - G="gridmask", + G="mask_grid", I="reverse", L="dist2line", N="mask", @@ -128,9 +130,9 @@ def select( ` *polygonfile*. For spherical polygons (lon, lat), make sure no consecutive points are separated by 180 degrees or more in longitude. - gridmask : str + mask_grid : str Pass all locations that are inside the valid data area of the grid - *gridmask*. Nodes that are outside are either NaN or zero. + *mask_grid*. Nodes that are outside are either NaN or zero. reverse : str [**cflrsz**]. Reverse the sense of the test for each of the criteria specified: @@ -138,7 +140,7 @@ def select( - **c** select records NOT inside any point's circle of influence. - **f** select records NOT inside any of the polygons. - **g** will pass records inside the cells with z equal zero of the - grid mask in ``gridmask``. + *mask_grid* in ``mask_grid``. - **l** select records NOT within the specified distance of any line. - **r** select records NOT inside the specified rectangular region. - **s** select records NOT considered inside as specified by ``mask``