Figure.grdcontour: Deprecate parameter "interval" to "levels" (FutureWarning since v0.12.0, will be removed in v0.16.0) #3209
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Apr 29, 2024
Closed
seisman
reviewed
Apr 29, 2024
| interval=250, | ||
| grid=grid, | ||
| ) | ||
| fig.grdcontour(annotation=1000, levels=250, grid=grid) |
There was a problem hiding this comment.
Can you please update this example to always put grid as the first parameter?
Suggested change
| fig.grdcontour(annotation=1000, levels=250, grid=grid) | |
| fig.grdcontour(grid=grid, annotation=1000, levels=250) |
Comment on lines
54
to
59
| fig.grdcontour( | ||
| annotation=1000, | ||
| interval=250, | ||
| levels=250, | ||
| grid=grid, | ||
| limit=[-4000, -2000], | ||
| ) |
There was a problem hiding this comment.
This code block and many others can be rewritten into a single line after we set the line length limit to 88 characters.
There was a problem hiding this comment.
Yes, I should find the time to make both updates. Should these be included in this PR, or better in separate PR and have this PR for the deprecation?
There was a problem hiding this comment.
Just submitted PR #3212 for working on this.
seisman
approved these changes
Apr 29, 2024
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
This PR deprecate the parameter
intervaltolevels(C) forFigur.grdcontour.Then this alias is consistent with
Figure.contour, the GMT documentation, and matplolib (details on the discussion at #1042 (comment)).Fixes #1042 (partly)
Preview: https://pygmt-dev--3209.org.readthedocs.build/en/3209/api/generated/pygmt.Figure.grdcontour.html
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash command is:
/format: automatically format and lint the code