From 7b22ae767b362cfa0c3e4291f1468eb6206ed218 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Tue, 16 Dec 2025 21:59:45 +0100 Subject: [PATCH] Deprecate skiprows to skip_rows --- pygmt/src/grd2xyz.py | 6 ++++-- pygmt/src/grdtrack.py | 6 ++++-- pygmt/src/select.py | 7 ++++--- pygmt/src/triangulate.py | 11 +++++++---- 4 files changed, 19 insertions(+), 11 deletions(-) diff --git a/pygmt/src/grd2xyz.py b/pygmt/src/grd2xyz.py index fe8b98d8060..48ec125d887 100644 --- a/pygmt/src/grd2xyz.py +++ b/pygmt/src/grd2xyz.py @@ -14,6 +14,7 @@ from pygmt.exceptions import GMTValueError from pygmt.helpers import ( build_arg_list, + deprecate_parameter, fmt_docstring, use_alias, validate_output_table_type, @@ -23,6 +24,7 @@ @fmt_docstring +@deprecate_parameter("skiprows", "skip_rows", "v0.18.0", remove_version="v0.20.0") @use_alias( C="cstyle", W="weight", @@ -31,7 +33,7 @@ d="nodata", f="coltypes", h="header", - s="skiprows", + s="skip_rows", ) def grd2xyz( grid: PathLike | xr.DataArray, @@ -119,7 +121,7 @@ def grd2xyz( $coltypes $header $outcols - $skiprows + $skip_rows Returns ------- diff --git a/pygmt/src/grdtrack.py b/pygmt/src/grdtrack.py index 236cff1da8e..3c536236c0e 100644 --- a/pygmt/src/grdtrack.py +++ b/pygmt/src/grdtrack.py @@ -14,6 +14,7 @@ from pygmt.exceptions import GMTInvalidInput from pygmt.helpers import ( build_arg_list, + deprecate_parameter, fmt_docstring, kwargs_to_strings, use_alias, @@ -24,6 +25,7 @@ @fmt_docstring +@deprecate_parameter("skiprows", "skip_rows", "v0.18.0", remove_version="v0.20.0") @use_alias( A="resample", C="crossprofile", @@ -43,7 +45,7 @@ h="header", j="distcalc", n="interpolation", - s="skiprows", + s="skip_rows", w="wrap", ) @kwargs_to_strings(S="sequence") @@ -269,7 +271,7 @@ def grdtrack( $distcalc $interpolation $outcols - $skiprows + $skip_rows $wrap Returns diff --git a/pygmt/src/select.py b/pygmt/src/select.py index b9f3168f034..59bb0a50c4c 100644 --- a/pygmt/src/select.py +++ b/pygmt/src/select.py @@ -25,6 +25,7 @@ @fmt_docstring @deprecate_parameter("mask", "mask_values", "v0.18.0", remove_version="v0.20.0") @deprecate_parameter("gridmask", "mask_grid", "v0.18.0", remove_version="v0.20.0") +@deprecate_parameter("skiprows", "skip_rows", "v0.18.0", remove_version="v0.20.0") @use_alias( A="area_thresh", C="dist2pt", @@ -40,7 +41,7 @@ f="coltypes", g="gap", h="header", - s="skiprows", + s="skip_rows", w="wrap", ) @kwargs_to_strings(N="sequence") @@ -171,7 +172,7 @@ def select( z_subregion : str or list *min*\ [/*max*]\ [**+a**]\ [**+c**\ *col*]\ [**+i**]. Pass all records whose 3rd column (*z*; *col* = 2) lies within the - given range or is NaN (use ``skiprows`` to skip NaN records). If *max* + given range or is NaN (use ``skip_rows`` to skip NaN records). If *max* is omitted then we test if *z* equals *min* instead. This means equality within 5 ULPs (unit of least precision; https://en.wikipedia.org/wiki/Unit_in_the_last_place). Input file must @@ -195,7 +196,7 @@ def select( $header $incols $outcols - $skiprows + $skip_rows $wrap Returns diff --git a/pygmt/src/triangulate.py b/pygmt/src/triangulate.py index 0fb5eeb003d..720093f90dc 100644 --- a/pygmt/src/triangulate.py +++ b/pygmt/src/triangulate.py @@ -14,6 +14,7 @@ from pygmt.clib import Session from pygmt.helpers import ( build_arg_list, + deprecate_parameter, fmt_docstring, use_alias, validate_output_table_type, @@ -50,13 +51,14 @@ class triangulate: # noqa: N801 @staticmethod @fmt_docstring + @deprecate_parameter("skiprows", "skip_rows", "v0.18.0", remove_version="v0.20.0") @use_alias( b="binary", d="nodata", e="find", f="coltypes", h="header", - s="skiprows", + s="skip_rows", w="wrap", ) def regular_grid( # noqa: PLR0913 @@ -132,7 +134,7 @@ def regular_grid( # noqa: PLR0913 $header $incols $registration - $skiprows + $skip_rows $wrap Returns @@ -176,13 +178,14 @@ def regular_grid( # noqa: PLR0913 @staticmethod @fmt_docstring + @deprecate_parameter("skiprows", "skip_rows", "v0.18.0", remove_version="v0.20.0") @use_alias( b="binary", d="nodata", e="find", f="coltypes", h="header", - s="skiprows", + s="skip_rows", w="wrap", ) def delaunay_triples( # noqa: PLR0913 @@ -247,7 +250,7 @@ def delaunay_triples( # noqa: PLR0913 $coltypes $header $incols - $skiprows + $skip_rows $wrap Returns