Skip to content

Figure.colorbar: Deprecate parameter equalsize to equal_size (Will be removed in v0.20.0) #4277

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

Figure.colorbar: Deprecate parameter equalsize to equal_size (Will be removed in v0.20.0) #4277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecd9ff8
Deprecate equalsize to equal_size
yvonnefroehlich Dec 12, 2025
3c71539
Update gallery example
yvonnefroehlich Dec 12, 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
2 changes: 1 addition & 1 deletion examples/gallery/embellishments/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
position="jBL+o0.5c/0.8c+h",
box=True,
# Divide colorbar into equal-sized rectangles
equalsize=0.5,
equal_size=0.5,
)

fig.show()
9 changes: 5 additions & 4 deletions pygmt/src/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@

from pygmt.alias import Alias, AliasSystem
from pygmt.clib import Session
from pygmt.helpers import build_arg_list, fmt_docstring, use_alias
from pygmt.helpers import build_arg_list, deprecate_parameter, fmt_docstring, use_alias
from pygmt.params import Box

__doctest_skip__ = ["colorbar"]


@fmt_docstring
@use_alias(C="cmap", D="position", L="equalsize", Z="zfile")
@deprecate_parameter("equalsize", "equal_size", "v0.18.0", remove_version="v0.20.0")
@use_alias(C="cmap", D="position", L="equal_size", Z="zfile")
def colorbar( # noqa: PLR0913
self,
truncate: Sequence[float] | None = None,
Expand Down Expand Up @@ -118,7 +119,7 @@ def colorbar( # noqa: PLR0913
from *-max_intens* to *+max_intens*.
- Passing a sequence of two numerical values (*low*, *high*) sets the intensity
range from *low* to *high* to specify an asymmetric range.
equalsize : float or str
equal_size : float or str
[**i**]\ [*gap*].
Equal-sized color rectangles. By default, the rectangles are scaled
according to the z-range in the CPT (see also ``zfile``). If *gap* is
Expand All @@ -134,7 +135,7 @@ def colorbar( # noqa: PLR0913
zfile : str
File with colorbar-width per color entry. By default, the width of the
entry is scaled to the color range, i.e., z = 0-100 gives twice the
width as z = 100-150 (see also ``equalsize``). **Note**: The widths
width as z = 100-150 (see also ``equal_size``). **Note**: The widths
may be in plot distance units or given as relative fractions and will
be automatically scaled so that the sum of the widths equals the
requested colorbar length.
Expand Down
Loading