Skip to content

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

Draft
yvonnefroehlich wants to merge 2 commits intomainfrom
deprecate-colorbar-equalsize
Draft

Figure.colorbar: Deprecate parameter equalsize to equal_size (Will be removed in v0.2X.0)#4277
yvonnefroehlich wants to merge 2 commits intomainfrom
deprecate-colorbar-equalsize

Conversation

@yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Dec 12, 2025

Description of proposed changes

Use underscores between words in parameter names; related to #2014.

Preview: https://pygmt-dev--4277.org.readthedocs.build/en/4277/api/generated/pygmt.Figure.colorbar.html

Guidelines

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added this to the 0.18.0 milestone Dec 12, 2025
@yvonnefroehlich yvonnefroehlich self-assigned this Dec 12, 2025
@yvonnefroehlich yvonnefroehlich added the deprecation Deprecating a feature label Dec 12, 2025
@seisman
Copy link
Member

seisman commented Dec 13, 2025

This parameter still takes non-Pythonic arguments, so need more dicsussions before renaming

@yvonnefroehlich yvonnefroehlich marked this pull request as draft December 13, 2025 06:45
@seisman seisman removed this from the 0.18.0 milestone Dec 18, 2025
@yvonnefroehlich yvonnefroehlich changed the title Figure.colorbar: Deprecate parameter equalsize to equal_size (Will be removed in v0.20.0) Figure.colorbar: Deprecate parameter equalsize to equal_size (Will be removed in v0.2X.0) Feb 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deprecation Deprecating a feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants