-
Notifications
You must be signed in to change notification settings - Fork 224
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
Raise a warning for the use of short-form parameters when long-forms are available #1316
Merged
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
seisman
force-pushed
the
warn-short-form-parameters
branch
from
June 2, 2021 21:10
557f16c
to
2938c2a
Compare
weiji14
changed the title
Raise an warning for the use of short-form parameters when long-forms are available
Raise a warning for the use of short-form parameters when long-forms are available
Jun 2, 2021
weiji14
reviewed
Jun 6, 2021
weiji14
approved these changes
Jun 16, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok to approve. Technically we should have written a test for this, but there are actually some tests still using short parameter names (as mentioned in #1316 (comment)) so I think it's alright to just merge it in as is.
weiji14
added
the
final review call
This PR requires final review and approval from a second reviewer
label
Jun 16, 2021
seisman
removed
the
final review call
This PR requires final review and approval from a second reviewer
label
Jun 17, 2021
weiji14
added a commit
to weiji14/deepicedrain
that referenced
this pull request
Jun 29, 2021
Silences the SyntaxWarnings raised in PyGMT v0.4.0 due to GenericMappingTools/pygmt#1316.
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
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
Address the comment in #1203 (comment).
When long-form parameters are available, we should recommend users not to use
the short-form parameters.
For example, running the following example:
will raise warnings like:
Reminders
make format
andmake check
to 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 commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version