Skip to content

Figure.histogram: Deprecate parameter barwidth to bar_width (Will be removed in v0.20.0) - #4279

Merged
seisman merged 3 commits into
mainfrom
deprecate-histogram-barwidth
Dec 16, 2025
Merged

Figure.histogram: Deprecate parameter barwidth to bar_width (Will be removed in v0.20.0) #4279
seisman merged 3 commits into
mainfrom
deprecate-histogram-barwidth

Conversation

@yvonnefroehlich

@yvonnefroehlichyvonnefroehlich commented Dec 12, 2025

Copy link
Copy Markdown
Member

Description of proposed changes

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

Preview: https://pygmt-dev--4279.org.readthedocs.build/en/4279/api/generated/pygmt.Figure.histogram.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

@yvonnefroehlichyvonnefroehlich added this to the 0.18.0 milestone Dec 12, 2025
@yvonnefroehlichyvonnefroehlich self-assigned this Dec 12, 2025
@yvonnefroehlichyvonnefroehlich added the deprecation Deprecating a feature label Dec 12, 2025
C="cmap",
D="annotate",
E="barwidth",
E="bar_width",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about split this option into two parameter bar_width and bar_offset?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would make the code more Pythonic and readable.

@seismanseismanDec 15, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you interested in working on this? It's a good time to get familiar with the new alias system.

Better to do it in a separate PR, so that we can have two entries in the changelog, one for the deprecation, one for the enhancement.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. Will give it a try 🙂.

@seismanseisman added the final review call This PR requires final review and approval from a second reviewer label Dec 15, 2025
@seisman
seisman merged commit 2366b88 into mainDec 16, 2025
25 checks passed
@seisman
seisman deleted the deprecate-histogram-barwidth branch December 16, 2025 01:53
@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 16, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deprecationDeprecating a feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@yvonnefroehlich@seisman