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