Skip to content

Commit fdbdf8b

Browse files
Update documentation of select.py (#2123)
1 parent ecdb66c commit fdbdf8b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

pygmt/src/select.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ def select(data=None, outfile=None, **kwargs):
7777
or (**c**)rude). The resolution drops off by ~80% between data sets.
7878
[Default is **l**]. Append (**+f**) to automatically select a lower
7979
resolution should the one requested not be available [Default is abort
80-
if not found]. **Note** that because the coastlines differ in details
80+
if not found]. Note that because the coastlines differ in details
8181
it is not guaranteed that a point will remain inside [or outside] when
8282
a different resolution is selected.
8383
gridmask : str
@@ -110,25 +110,25 @@ def select(data=None, outfile=None, **kwargs):
110110
land].
111111
{region}
112112
{verbose}
113-
z_subregion : str
113+
z_subregion : str or list
114114
*min*\ [/*max*]\ [**+a**]\ [**+c**\ *col*]\ [**+i**].
115115
Pass all records whose 3rd column (*z*; *col* = 2) lies within the
116116
given range or is NaN (use ``skiprows`` to skip NaN records). If *max*
117117
is omitted then we test if *z* equals *min* instead. This means
118118
equality within 5 ULPs (unit of least precision;
119119
http://en.wikipedia.org/wiki/Unit_in_the_last_place). Input file must
120-
have at least three columns. To indicate no limit on min or max,
120+
have at least three columns. To indicate no limit on *min* or *max*,
121121
specify a hyphen (-). If your 3rd column is absolute time then remember
122122
to supply ``coltypes="2T"``. To specify another column, append
123-
**+c**\ *col*, and to specify several tests just repeat the
124-
``z_subregion`` option as many times as you have columns to test.
125-
**Note**: When more than one ``z_subregion`` option is given then the
126-
``reverse="z"`` option cannot be used. In the case of multiple tests
123+
**+c**\ *col*, and to specify several tests pass a list of arguments
124+
as you have columns to test.
125+
**Note**: When more than one ``z_subregion`` argument is given then the
126+
``reverse="z"`` cannot be used. In the case of multiple tests
127127
you may use these modifiers as well: **+a** passes any record that
128128
passes at least one of your *z* tests [Default is all tests must pass],
129129
and **+i** reverses the tests to pass record with *z* value NOT in the
130130
given range. Finally, if **+c** is not used then it is automatically
131-
incremented for each new ``z_subregion`` option, starting with 2.
131+
incremented for each new ``z_subregion`` argument, starting with 2.
132132
{binary}
133133
{nodata}
134134
{find}

0 commit comments

Comments
 (0)