Skip to content

pygmt.grdclip: Remove parameter 'new' (Deprecated since v0.15.0) #4343

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 3 commits into from
Jan 17, 2026
+1 −9
Merged

pygmt.grdclip: Remove parameter 'new' (Deprecated since v0.15.0) #4343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
136d450
Remove parameter 'new'
yvonnefroehlich Jan 13, 2026
9033eec
Remove test for parameter 'new'
yvonnefroehlich Jan 13, 2026
8bcca1c
Merge branch 'main' into remove-grdclip-new
seisman Jan 17, 2026
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
4 changes: 1 addition & 3 deletions pygmt/src/grdclip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,12 @@
from pygmt.alias import Alias, AliasSystem
from pygmt.clib import Session
from pygmt.exceptions import GMTInvalidInput
from pygmt.helpers import build_arg_list, deprecate_parameter, fmt_docstring
from pygmt.helpers import build_arg_list, fmt_docstring

__doctest_skip__ = ["grdclip"]


# TODO(PyGMT>=0.19.0): Remove the deprecated "new" parameter.
@fmt_docstring
@deprecate_parameter("new", "replace", "v0.15.0", remove_version="v0.19.0")
def grdclip(
grid: PathLike | xr.DataArray,
outgrid: PathLike | None = None,
Expand Down
6 changes: 0 additions & 6 deletions pygmt/tests/test_grdclip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,6 @@ def test_grdclip_replace():
grid = grdclip(grid=grid, replace=[0, 2]) # Replace 0 with 2
npt.assert_array_equal(np.unique(grid), [1, 2])

# Test for the deprecated 'new' parameter
# TODO(PyGMT>=0.19.0): Remove this test below for the 'new' parameter
with pytest.warns(FutureWarning):
grid = grdclip(grid=grid, new=[1, 3]) # Replace 1 with 3
npt.assert_array_equal(np.unique(grid), [2, 3])


def test_grdclip_between_repeated():
"""
Expand Down
Loading