diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index a8866532928..6e57b9b48f4 100644 --- a/pygmt/helpers/decorators.py +++ b/pygmt/helpers/decorators.py @@ -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 @@ -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)]. A unit **u** may be appended to the specified *gap*: @@ -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.