Skip to content

pygmt.project: Deprecate parameter unit to units (Will be removed in v0.20.0) #4297

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

Draft
yvonnefroehlich wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

pygmt.project: Deprecate parameter unit to units (Will be removed in v0.20.0) #4297

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1013809
Deprecate unit to units
yvonnefroehlich Dec 17, 2025
57099a2
Be strict with single and plural in parameter name regarding input
yvonnefroehlich Dec 17, 2025
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/project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,21 @@
from pygmt.exceptions import GMTInvalidInput
from pygmt.helpers import (
build_arg_list,
deprecate_parameter,
fmt_docstring,
use_alias,
validate_output_table_type,
)


@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",
Expand Down Expand Up @@ -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]
Expand Down