Skip to content
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.

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

Figure.grdimage: Deprecate parameter "bit_color" to "bitcolor" (remove in v0.12.0) #2635

Merged
merged 4 commits into from
Aug 21, 2023

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Aug 19, 2023

Description of proposed changes

To follow the Code style and to be consistent with the similar parameter of pygmt.Figure.image, this PR aims to deprecate the parameter bit_color to bitcolor of pygmt.Figure.grdimage. The FutureWarning warning is currently raised for 2 minor releases.

For context see: #2615 (comment) and #2615 (comment)

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

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

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@yvonnefroehlich yvonnefroehlich added the deprecation Deprecating a feature label Aug 19, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.10.0 milestone Aug 19, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Aug 19, 2023
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Aug 19, 2023
@seisman seisman merged commit 14b045a into main Aug 21, 2023
@seisman seisman deleted the change-grdimage-bit_color2bitcolor branch August 21, 2023 02:03
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Aug 21, 2023
@seisman seisman changed the title Figure.image: Deprecate parameter "bit_color" to "bitcolor" (remove in v0.12.0) Figure.grdimage: Deprecate parameter "bit_color" to "bitcolor" (remove in v0.12.0) Feb 3, 2024
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