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

Author: yvonnefroehlich

pygmt/src/x2sys_cross.py

@@ -16,6 +16,7 @@
 from pygmt.helpers import (
     build_arg_list,
     data_kind,
+    deprecate_parameter,
     fmt_docstring,
     unique_name,
     use_alias,
@@ -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",
@@ -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,
@@ -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].
 

pygmt/tests/test_x2sys_cross.py

@@ -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"}: