Figure.wiggle: Reorder input parameter to 'data, x, y, z' (#1548)

Co-authored-by: Wei Ji <[email protected]>

Author: seisman

pygmt/helpers/decorators.py

@@ -857,7 +857,15 @@ def new_module(*args, **kwargs):
             New module instance that raises a warning if positional arguments
             are passed.
             """
-            if len(args) > 0:  # positional arguments are used
+            # Plotting functions always have a "self" parameter
+            # which is a pygmt.Figure instance that has a "savefig" method
+            if len(args) > 1 and hasattr(args[0], "savefig"):
+                plotting_func = 1
+            else:
+                plotting_func = 0
+
+            if len(args) > 1 + plotting_func:
+                # more than one positional arguments are used
                 msg = (
                     "The function parameters has been re-ordered as 'data, x, y, [z]' "
                     f"since {deprecate_version} but you're passing positional arguments. "

pygmt/src/wiggle.py

@@ -4,6 +4,7 @@
 from pygmt.clib import Session
 from pygmt.helpers import (
     build_arg_string,
+    check_data_input_order,
     deprecate_parameter,
     fmt_docstring,
     kwargs_to_strings,
@@ -13,6 +14,7 @@
 
 @fmt_docstring
 @deprecate_parameter("columns", "incols", "v0.5.0", remove_version="v0.7.0")
+@check_data_input_order("v0.5.0", remove_version="v0.7.0")
 @use_alias(
     B="frame",
     D="position",
@@ -39,7 +41,7 @@
     w="wrap",
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", i="sequence_comma", p="sequence")
-def wiggle(self, x=None, y=None, z=None, data=None, **kwargs):
+def wiggle(self, data=None, x=None, y=None, z=None, **kwargs):
     r"""
     Plot z=f(x,y) anomalies along tracks.
 

pygmt/tests/test_wiggle.py

@@ -50,9 +50,9 @@ def test_wiggle_deprecate_columns_to_incols():
     fig = Figure()
     with pytest.warns(expected_warning=FutureWarning) as record:
         fig.wiggle(
+            data,
             region=[-4, 4, -1, 1],
             projection="X8c",
-            data=data,
             columns=[1, 0, 2],
             scale="0.5c",
             color=["red+p", "gray+n"],