From 101380957c6d52d82fbc85f2422489a399606f84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Wed, 17 Dec 2025 06:30:25 +0100 Subject: [PATCH 1/2] Deprecate unit to units --- pygmt/src/grdproject.py | 7 ++++--- pygmt/src/project.py | 6 ++++-- pygmt/src/sphdistance.py | 7 ++++--- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/pygmt/src/grdproject.py b/pygmt/src/grdproject.py index eb2b66e1f9a..e67747dcc6a 100644 --- a/pygmt/src/grdproject.py +++ b/pygmt/src/grdproject.py @@ -10,13 +10,14 @@ from pygmt.alias import Alias, AliasSystem from pygmt.clib import Session from pygmt.exceptions import GMTInvalidInput -from pygmt.helpers import build_arg_list, fmt_docstring, use_alias +from pygmt.helpers import build_arg_list, deprecate_parameter, fmt_docstring, use_alias __doctest_skip__ = ["grdproject"] @fmt_docstring -@use_alias(E="dpi", F="scaling", I="inverse", M="unit", n="interpolation") +@deprecate_parameter("unit", "units", "v0.18.0", remove_version="v0.20.0") +@use_alias(E="dpi", F="scaling", I="inverse", M="units", n="interpolation") def grdproject( grid: PathLike | xr.DataArray, outgrid: PathLike | None = None, @@ -83,7 +84,7 @@ def grdproject( **k** (kilometers), **M** (statute miles), **n** (nautical miles), **u** (US survey feet), **i** (inches), **c** (centimeters), or **p** (points). - unit : str + units : str Append **c**, **i**, or **p** to indicate that centimeters, inches, or points should be the projected measure unit. Cannot be used with ``scaling``. diff --git a/pygmt/src/project.py b/pygmt/src/project.py index ad88345d1cb..15ef1306c0a 100644 --- a/pygmt/src/project.py +++ b/pygmt/src/project.py @@ -13,6 +13,7 @@ from pygmt.exceptions import GMTInvalidInput from pygmt.helpers import ( build_arg_list, + deprecate_parameter, fmt_docstring, use_alias, validate_output_table_type, @@ -20,12 +21,13 @@ @fmt_docstring +@deprecate_parameter("unit", "units", "v0.18.0", remove_version="v0.20.0") @use_alias( A="azimuth", F="convention", G="generate", N="flat_earth", - Q="unit", + Q="units", S="sort", Z="ellipse", f="coltypes", @@ -174,7 +176,7 @@ def project( # noqa: PLR0913 Make a Cartesian coordinate transformation in the plane. [Default is ``False``; plane created with spherical trigonometry.] - unit : bool + units : bool Set units for :math:`x, y, r, s` to degrees and :math:`p, q, dist, l_{min}, l_{max}, w_{min}, w_{max}` to km. [Default is ``False``; all arguments use the same units] diff --git a/pygmt/src/sphdistance.py b/pygmt/src/sphdistance.py index 6d4af6c46ec..f1e3cbda779 100644 --- a/pygmt/src/sphdistance.py +++ b/pygmt/src/sphdistance.py @@ -11,17 +11,18 @@ from pygmt.alias import Alias, AliasSystem from pygmt.clib import Session from pygmt.exceptions import GMTInvalidInput -from pygmt.helpers import build_arg_list, fmt_docstring, use_alias +from pygmt.helpers import build_arg_list, deprecate_parameter, fmt_docstring, use_alias __doctest_skip__ = ["sphdistance"] @fmt_docstring +@deprecate_parameter("unit", "units", "v0.18.0", remove_version="v0.20.0") @use_alias( C="single_form", D="duplicate", E="quantity", - L="unit", + L="units", N="node_table", Q="voronoi", ) @@ -85,7 +86,7 @@ def sphdistance( Optionally, append the resampling interval along Voronoi arcs in spherical degrees. - unit : str + units : str Specify the unit used for distance calculations. Choose among **d** (spherical degrees), **e** (meters), **f** (feet), **k** (kilometers), **M** (miles), **n** (nautical miles), or **u** (survey feet). From 57099a2c4801231f6d250100827361608716d0ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Wed, 17 Dec 2025 07:18:06 +0100 Subject: [PATCH 2/2] Be strict with single and plural in parameter name regarding input --- pygmt/src/grdproject.py | 7 +++---- pygmt/src/sphdistance.py | 7 +++---- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/pygmt/src/grdproject.py b/pygmt/src/grdproject.py index e67747dcc6a..eb2b66e1f9a 100644 --- a/pygmt/src/grdproject.py +++ b/pygmt/src/grdproject.py @@ -10,14 +10,13 @@ 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, use_alias +from pygmt.helpers import build_arg_list, fmt_docstring, use_alias __doctest_skip__ = ["grdproject"] @fmt_docstring -@deprecate_parameter("unit", "units", "v0.18.0", remove_version="v0.20.0") -@use_alias(E="dpi", F="scaling", I="inverse", M="units", n="interpolation") +@use_alias(E="dpi", F="scaling", I="inverse", M="unit", n="interpolation") def grdproject( grid: PathLike | xr.DataArray, outgrid: PathLike | None = None, @@ -84,7 +83,7 @@ def grdproject( **k** (kilometers), **M** (statute miles), **n** (nautical miles), **u** (US survey feet), **i** (inches), **c** (centimeters), or **p** (points). - units : str + unit : str Append **c**, **i**, or **p** to indicate that centimeters, inches, or points should be the projected measure unit. Cannot be used with ``scaling``. diff --git a/pygmt/src/sphdistance.py b/pygmt/src/sphdistance.py index f1e3cbda779..6d4af6c46ec 100644 --- a/pygmt/src/sphdistance.py +++ b/pygmt/src/sphdistance.py @@ -11,18 +11,17 @@ 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, use_alias +from pygmt.helpers import build_arg_list, fmt_docstring, use_alias __doctest_skip__ = ["sphdistance"] @fmt_docstring -@deprecate_parameter("unit", "units", "v0.18.0", remove_version="v0.20.0") @use_alias( C="single_form", D="duplicate", E="quantity", - L="units", + L="unit", N="node_table", Q="voronoi", ) @@ -86,7 +85,7 @@ def sphdistance( Optionally, append the resampling interval along Voronoi arcs in spherical degrees. - units : str + unit : str Specify the unit used for distance calculations. Choose among **d** (spherical degrees), **e** (meters), **f** (feet), **k** (kilometers), **M** (miles), **n** (nautical miles), or **u** (survey feet).