Skip to content

Improve docstring of x2sys_init and x2sys_cross #930

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

Merged
merged 12 commits into from
Feb 20, 2021
Merged
Changes from 1 commit
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
4 changes: 2 additions & 2 deletions pygmt/x2sys.py
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,8 @@ def x2sys_cross(tracks=None, outfile=None, **kwargs):
- **l** sets lower speed [Default is 0].
- **u** sets upper speed [Default is Infinity].
- **h** does not limit the speed but sets a lower speed below which \
headings will not be computed (i.e., set to NaN) [Default calculates \
headings regardless of speed].
headings will not be computed (i.e., set to NaN) [Default \
calculates headings regardless of speed].

For example, you can use ``speed=["l0", "u10", "h5"]`` to set a lower
speed of 0, upper speed of 10, and disable heading calculations for
Expand Down