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.velo: Deprecate parameters "color" to "fill" and "uncertaintycolor" to "uncertaintyfill" (remove in v0.12.0) #2206

Merged
merged 5 commits into from
Nov 25, 2022

Conversation

michaelgrund
Copy link
Member

Addresses #1617

Description of proposed changes

Fixes #

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.

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

@michaelgrund michaelgrund added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Nov 23, 2022
@michaelgrund michaelgrund added this to the 0.8.0 milestone Nov 23, 2022
@michaelgrund
Copy link
Member Author

/format

@michaelgrund michaelgrund added the needs review This PR has higher priority and needs review. label Nov 23, 2022


@fmt_docstring
@deprecate_parameter("color", "fill", "v0.8.0", "v0.12.0")
@use_alias(
A="vector",
B="frame",
C="cmap",
D="rescale",
E="uncertaintycolor",
Copy link
Member

Choose a reason for hiding this comment

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

I'm wondering if we should also deprecated uncertaintycolor to uncertaintyfill.

Copy link
Member Author

@michaelgrund michaelgrund Nov 24, 2022

Choose a reason for hiding this comment

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

In my opinion, yes since it also colors the inside of a polygon! I made some changes. If we go with uncertaintyfill then test_velo.py also needs to be updated.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, please also update test_velo.py then we can ping other maintainers to see what they think about the two deprecations.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done @seisman.

@michaelgrund michaelgrund changed the title Figure.velo: Deprecate parameter "color" to "fill" (remove in v0.12.0) Figure.velo: Deprecate parameters "color" to "fill" and "uncertaintycolor" to "uncertaintyfill" (remove in v0.12.0) Nov 24, 2022
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

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

Looks good to me, but let's see what other @GenericMappingTools/pygmt-maintainers say about the two deprecated parameters.

@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Nov 24, 2022
@weiji14 weiji14 added the deprecation Deprecating a feature label Nov 24, 2022
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Yep, ok with double deprecation!

@seisman seisman removed maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Nov 25, 2022
@seisman seisman merged commit 5644d99 into main Nov 25, 2022
@seisman seisman deleted the velo-deprecate-color-to-fill branch November 25, 2022 07:38
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@weiji14 weiji14 removed the final review call This PR requires final review and approval from a second reviewer label Dec 29, 2022
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.

4 participants