Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update deprecated -g common option syntax #1670

Merged
merged 5 commits into from
Dec 17, 2021
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions pygmt/helpers/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -170,14 +170,12 @@
:gmt-docs:`gmt.html#f-full`.""",
"g": r"""
gap : str or list
[**a**]\ **x**\|\ **y**\|\ **d**\|\ **X**\|\ **Y**\|\
**D**\|[*col*]\ **z**\ *gap*\ [**+n**\|\ **p**].
**x**\|\ **y**\|\ **z**\|\ **d**\|\ **X**\|\ **Y**\|\
**D**\ *gap*\ [**u**][**+a**][**+c**\ *col*][**+n**\|\ **p**].
Examine the spacing between consecutive data points in order to
impose breaks in the line. To specify multiple criteria, provide
a list with each item containing a string describing one set of
criteria. Prepend **a** to specify that all the criteria must be
met [Default is to impose breaks if any criteria are met]. The
following modifiers are supported:
criteria.

- **x**\|\ **X** - define a gap when there is a large enough
change in the x coordinates (upper case to use projected
Expand All @@ -188,9 +186,9 @@
- **d**\|\ **D** - define a gap when there is a large enough
distance between coordinates (upper case to use projected
coordinates).
- [*col*]\ **z** - define a gap when there is a large enough
change in the data in column *col* [default *col* is 2 (i.e.,
3rd column)].
- **z** - define a gap when there is a large enough change in
the z data. Use **+c**\ *col* to change the z data column
[Default *col* is 2 (i.e., 3rd column)].
michaelgrund marked this conversation as resolved.
Show resolved Hide resolved

A unit **u** may be appended to the specified *gap*:

Expand All @@ -202,9 +200,10 @@
- For projected data (**X**\|\ **Y**\|\ **D**), the unit may be
**i**\ (nch), **c**\ (entimeter), or **p**\ (oint).

One of the following modifiers can be appended to *gap* [Default
imposes breaks based on the absolute value of the difference
between the current and previous value]:
Append modifier **+a** to specify that *all* the criteria must be
met [default imposes breaks if any one criterion is met].

One of the following modifiers can be appended:

- **+n** - specify that the previous value minus the current
column value must exceed *gap* for a break to be imposed.
Expand Down