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.contour: Deprecate parameter "columns" to "incols" (remove in v0.6.0) #1303

Merged
merged 13 commits into from
Jun 6, 2021

Conversation

michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented May 27, 2021

Description of proposed changes

This PR adds the incols parameter description to Figure.contour() and adds the deprecate_parameter decorator for backward-compatibility.

Fixes #1313.

  • Updates tests and examples to use the new parameter name
  • Use the deprecate_parameter decorator for backward-compatibility
  • Add a test for checking 'columns' backward compatibility

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.
  • Write detailed docstrings for all functions/methods.

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 the deprecation Deprecating a feature label May 27, 2021
@michaelgrund michaelgrund added this to the 0.4.0 milestone May 27, 2021
@michaelgrund michaelgrund self-assigned this May 27, 2021
@weiji14 weiji14 mentioned this pull request Jun 2, 2021
13 tasks
@seisman seisman marked this pull request as ready for review June 6, 2021 21:23
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Jun 6, 2021
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jun 6, 2021
@seisman seisman changed the title Figure.contour: Add and deprecate parameter "columns" to "incols" (remove in v0.6.0) Figure.contour: Deprecate parameter "columns" to "incols" (remove in v0.6.0) Jun 6, 2021
@seisman seisman merged commit 37819c6 into master Jun 6, 2021
@seisman seisman deleted the contour-add-incols branch June 6, 2021 22:29
seisman pushed a commit that referenced this pull request Jun 8, 2021
…v0.6.0) (#1303)

* Figure.contour: Add and deprecate parameter "columns" to "incols" (remove in v0.6.0)
* add test for deprecation warning
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…v0.6.0) (GenericMappingTools#1303)

* Figure.contour: Add and deprecate parameter "columns" to "incols" (remove in v0.6.0)
* add test for deprecation warning
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.

The "incols" (-i) parameter doesn't works for vector input correctly
3 participants