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

pygmt.xyz2grd: Rename the parameter 'table' to 'data' #1545

Merged
merged 1 commit into from
Sep 27, 2021

Conversation

seisman
Copy link
Member

@seisman seisman commented Sep 26, 2021

Description of proposed changes

Rename the parameter 'table' to 'data' without a deprecation cycle,
because the xyz2grd function was added after v0.4.1.

Address #1479.

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 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

Rename the parameter 'table' to 'data' without a deprecation cycle,
because the xyz2grd function was added after v0.4.1.
@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Sep 26, 2021
@seisman seisman added this to the 0.5.0 milestone Sep 26, 2021
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Sep 26, 2021
@willschlitzer
Copy link
Contributor

Just to confirm, we're not using the deprecate_parameter decorator here because xyz2grd isn't in a release yet?

@seisman
Copy link
Member Author

seisman commented Sep 26, 2021

Just to confirm, we're not using the deprecate_parameter decorator here because xyz2grd isn't in a release yet?

Yes. In my opinion, "main" branch means unstable, and we are allowed to make changes to features that are not released.

@willschlitzer
Copy link
Contributor

Just to confirm, we're not using the deprecate_parameter decorator here because xyz2grd isn't in a release yet?

Yes. In my opinion, "main" branch means unstable, and we are allowed to make changes to features that are not released.

I agree!

@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed final review call This PR requires final review and approval from a second reviewer labels Sep 26, 2021
@seisman seisman merged commit 4bb2396 into main Sep 27, 2021
@seisman seisman deleted the xyz2grd-table-to-data branch September 27, 2021 01:16
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…Tools#1545)

Rename the parameter 'table' to 'data' without a deprecation cycle,
because the xyz2grd function was added after v0.4.1.
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.

4 participants