Skip to content

Commit 5bc0682

Browse files
Figure.plot: Update docstring for "connection" parameter to GMT 6.5 (#2994)
1 parent 0a3b46d commit 5bc0682

File tree

1 file changed

+20
-27
lines changed

1 file changed

+20
-27
lines changed

pygmt/src/plot.py

Lines changed: 20 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -122,37 +122,30 @@ def plot( # noqa: PLR0912
122122
Draw error bars. Full documentation is at
123123
:gmt-docs:`plot.html#e`.
124124
connection : str
125-
[**c**\|\ **n**\|\ **r**]\
126-
[**a**\|\ **f**\|\ **s**\|\ **r**\|\ *refpoint*].
127-
Alter the way points are connected (by specifying a *scheme*) and
128-
data are grouped (by specifying a *method*). Append one of three
129-
line connection schemes:
125+
[**c**\|\ **n**\|\ **p**][**a**\|\ **r**\|\ **s**\|\ **t**\|\ *refpoint*].
126+
Alter the way points are connected (by specifying a *scheme*) and data are
127+
grouped (by specifying a *method*). Append one of three line connection schemes:
130128
131-
- **c** : Draw continuous line segments for each group [Default].
132-
- **r** : Draw line segments from a reference point reset for each
133-
group.
134-
- **n** : Draw networks of line segments between all points in
135-
each group.
129+
- **c**: Draw continuous line segments for each group [Default].
130+
- **n**: Draw networks of line segments between all points in each group.
131+
- **p**: Draw line segments from a reference point reset for each group.
136132
137-
Optionally, append the one of four segmentation methods to define
138-
the group:
133+
Optionally, append the one of four segmentation methods to define the group:
139134
140-
- **a** : Ignore all segment headers, i.e., let all points belong
141-
to a single group, and set group reference point to the very
142-
first point of the first file.
143-
- **f** : Consider all data in each file to be a single separate
144-
group and reset the group reference point to the first point of
145-
each group.
146-
- **s** : Segment headers are honored so each segment is a group;
147-
the group reference point is reset to the first point of each
148-
incoming segment [Default].
149-
- **r** : Same as **s**, but the group reference point is reset
150-
after each record to the previous point (this method is only
151-
available with the ``connection="r"`` scheme).
135+
- **a**: Ignore all segment headers, i.e., let all points belong to a single
136+
group, and set group the reference point to the very first point of the first
137+
file.
138+
- **r**: Segment headers are honored so each segment is a group; the group
139+
reference point is reset after each record to the previous point (this method
140+
is only available with the ``connection="p"`` scheme).
141+
- **s**: Same as **r**, but the group reference point is reset to the first
142+
point of each incoming segment [Default].
143+
- **t**: Consider all data in each file to be a single separate group and reset
144+
the group reference point to the first point of each group.
152145
153-
Instead of the codes **a**\|\ **f**\|\ **s**\|\ **r** you may append
154-
the coordinates of a *refpoint* which will serve as a fixed external
155-
reference point for all groups.
146+
Instead of the codes **a**\|\ **r**\|\ **s**\|\ **t** you may append the
147+
coordinates of a *refpoint* which will serve as a fixed external reference point
148+
for all groups.
156149
{fill}
157150
*fill* can be a 1-D array, but it is only valid if using ``x``/``y``
158151
and ``cmap=True`` is also required.

0 commit comments

Comments
 (0)