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

Figure.plot: Update docstring for "connection" parameter to GMT 6.5 #2994

Merged
merged 13 commits into from
Jan 14, 2024
Merged
30 changes: 15 additions & 15 deletions pygmt/src/plot.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,35 +122,35 @@ def plot( # noqa: PLR0912
Draw error bars. Full documentation is at
:gmt-docs:`plot.html#e`.
connection : str
[**c**\|\ **n**\|\ **r**]\
[**a**\|\ **f**\|\ **s**\|\ **r**\|\ *refpoint*].
[**c**\|\ **n**\|\ **p**]\
seisman marked this conversation as resolved.
Show resolved Hide resolved
[**a**\|\ **r**\|\ **s**\|\ **t**\|\ *refpoint*].
yvonnefroehlich marked this conversation as resolved.
Show resolved Hide resolved
Alter the way points are connected (by specifying a *scheme*) and
data are grouped (by specifying a *method*). Append one of three
line connection schemes:

- **c** : Draw continuous line segments for each group [Default].
- **r** : Draw line segments from a reference point reset for each
group.
- **n** : Draw networks of line segments between all points in
- **c**: Draw continuous line segments for each group [Default].
- **n**: Draw networks of line segments between all points in
each group.
- **p**: Draw line segments from a reference point reset for each
group.

Optionally, append the one of four segmentation methods to define
the group:

- **a** : Ignore all segment headers, i.e., let all points belong
- **a**: Ignore all segment headers, i.e., let all points belong
to a single group, and set group reference point to the very
first point of the first file.
- **f** : Consider all data in each file to be a single separate
- **r**: Segment headers are honored so each segment is a group;
the group reference point is reset after each record to the
previous point (this method is only available with the
``connection="p"`` scheme).
- **s**: Same as **r**, but the group reference point is reset
to the first point of each incoming segment [Default].
- **t**: Consider all data in each file to be a single separate
group and reset the group reference point to the first point of
each group.
- **s** : Segment headers are honored so each segment is a group;
the group reference point is reset to the first point of each
incoming segment [Default].
- **r** : Same as **s**, but the group reference point is reset
after each record to the previous point (this method is only
available with the ``connection="r"`` scheme).

Instead of the codes **a**\|\ **f**\|\ **s**\|\ **r** you may append
Instead of the codes **a**\|\ **r**\|\ **s**\|\ **t** you may append
the coordinates of a *refpoint* which will serve as a fixed external
reference point for all groups.
{fill}
Expand Down
Loading