Skip to content

Use remove_version keyword arguments in the deprecate_parameter decorator #2212

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

Merged
merged 1 commit into from
Nov 28, 2022

Conversation

seisman
Copy link
Member

@seisman seisman commented Nov 26, 2022

Description of proposed changes

So that we can use grep --include="*.py" -r 'remove_version="vX.Y.Z"' to find the deprecated parameters that should be removed when making a new release.

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

@seisman seisman requested a review from michaelgrund November 26, 2022 05:01
@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Nov 26, 2022
@seisman seisman added this to the 0.8.0 milestone Nov 26, 2022
@weiji14 weiji14 changed the title Use remove_version keyword arguements in the deprecate_parameter decorator Use remove_version keyword arguments in the deprecate_parameter decorator Nov 26, 2022
Copy link
Contributor

@willschlitzer willschlitzer 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!

Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

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

Good point!

@seisman seisman merged commit 10973aa into main Nov 28, 2022
@seisman seisman deleted the remove-version branch November 28, 2022 03:22
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants