Skip to content

pygmt.x2sys_cross: Deprecate parameter trackvalues to track_values (Will be removed in v0.20.0) #4282

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.

Sign up for GitHub

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
seisman merged 2 commits into from
Dec 13, 2025
Merged

pygmt.x2sys_cross: Deprecate parameter trackvalues to track_values (Will be removed in v0.20.0) #4282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e14f6d
Deprecate maskvalues to maks_values
yvonnefroehlich Dec 12, 2025
5d94fe7
Update test
yvonnefroehlich Dec 12, 2025
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
6 changes: 4 additions & 2 deletions pygmt/src/x2sys_cross.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
from pygmt.helpers import (
build_arg_list,
data_kind,
deprecate_parameter,
fmt_docstring,
unique_name,
use_alias,
Expand Down Expand Up @@ -58,6 +59,7 @@ def tempfile_from_dftrack(track, suffix):


@fmt_docstring
@deprecate_parameter("trackvalues", "track_values", "v0.18.0", remove_version="v0.20.0")
@use_alias(
A="combitable",
C="runtimes",
Expand All @@ -67,7 +69,7 @@ def tempfile_from_dftrack(track, suffix):
T="tag",
Q="coe",
W="numpoints",
Z="trackvalues",
Z="track_values",
)
def x2sys_cross(
tracks=None,
Expand Down Expand Up @@ -182,7 +184,7 @@ def x2sys_cross(
Give the maximum number of data points on either side of the crossover
to use in the spline interpolation [Default is 3].

trackvalues : bool
track_values : bool
Report the values of each track at the crossover [Default reports the
crossover value and the mean value].

Expand Down
6 changes: 3 additions & 3 deletions pygmt/tests/test_x2sys_cross.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,14 +267,14 @@ def test_x2sys_cross_region_interpolation_numpoints():


@pytest.mark.usefixtures("mock_x2sys_home")
def test_x2sys_cross_trackvalues():
def test_x2sys_cross_track_values():
"""
Test that x2sys_cross's trackvalues (Z) argument work.
Test that x2sys_cross's track_values (Z) argument work.
"""
with TemporaryDirectory(prefix="X2SYS", dir=Path.cwd()) as tmpdir:
tag = Path(tmpdir).name
x2sys_init(tag=tag, fmtfile="xyz", force=True)
output = x2sys_cross(tracks=["@tut_ship.xyz"], tag=tag, trackvalues=True)
output = x2sys_cross(tracks=["@tut_ship.xyz"], tag=tag, track_values=True)

assert isinstance(output, pd.DataFrame)
if platform.machine() in {"aarch64", "arm64"}:
Expand Down