Figure.histogram: Deprecate parameter barwidth to bar_width (Will be removed in v0.20.0) #4279
+13
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seisman
reviewed
Dec 14, 2025
| C="cmap", | ||
| D="annotate", | ||
| E="barwidth", | ||
| E="bar_width", |
Member
There was a problem hiding this comment.
What about split this option into two parameter bar_width and bar_offset?
Member
Author
There was a problem hiding this comment.
This would make the code more Pythonic and readable.
Member
There was a problem hiding this comment.
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.
Member
Author
There was a problem hiding this comment.
Sounds good. Will give it a try 🙂.
seisman
added
the
final review call
seisman
approved these changes
Dec 15, 2025
seisman
removed
the
final review call
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 performspecific operations. Supported slash command is:
/format: automatically format and lint the code