Skip to content

Deprecate parameter skiprows to skip_rows (Will be removed in v0.20.0) #4295

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

Closed
yvonnefroehlich wants to merge 1 commit into from
Closed

Deprecate parameter skiprows to skip_rows (Will be removed in v0.20.0) #4295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/grd2xyz.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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",
Expand All @@ -31,7 +33,7 @@
d="nodata",
f="coltypes",
h="header",
s="skiprows",
s="skip_rows",
)
def grd2xyz(
grid: PathLike | xr.DataArray,
Expand Down Expand Up @@ -119,7 +121,7 @@ def grd2xyz(
$coltypes
$header
$outcols
$skiprows
$skip_rows

Returns
-------
Expand Down
6 changes: 4 additions & 2 deletions pygmt/src/grdtrack.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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",
Expand All @@ -43,7 +45,7 @@
h="header",
j="distcalc",
n="interpolation",
s="skiprows",
s="skip_rows",
w="wrap",
)
@kwargs_to_strings(S="sequence")
Expand Down Expand Up @@ -269,7 +271,7 @@ def grdtrack(
$distcalc
$interpolation
$outcols
$skiprows
$skip_rows
$wrap

Returns
Expand Down
7 changes: 4 additions & 3 deletions pygmt/src/select.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -40,7 +41,7 @@
f="coltypes",
g="gap",
h="header",
s="skiprows",
s="skip_rows",
w="wrap",
)
@kwargs_to_strings(N="sequence")
Expand Down Expand Up @@ -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
Expand All @@ -195,7 +196,7 @@ def select(
$header
$incols
$outcols
$skiprows
$skip_rows
$wrap

Returns
Expand Down
11 changes: 7 additions & 4 deletions pygmt/src/triangulate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -132,7 +134,7 @@ def regular_grid( # noqa: PLR0913
$header
$incols
$registration
$skiprows
$skip_rows
$wrap

Returns
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -247,7 +250,7 @@ def delaunay_triples( # noqa: PLR0913
$coltypes
$header
$incols
$skiprows
$skip_rows
$wrap

Returns
Expand Down
Loading