Add a reminder to use underscores in file and directory names to the PR checklist #2246
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
added
maintenance
michaelgrund
approved these changes
Dec 13, 2022
| @@ -16,6 +16,7 @@ Fixes # | |||
| - [ ] 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. | |||
| - [ ] Use underscores (not hyphens) in names of Python files and directories. | |||
There was a problem hiding this comment.
Should this also say that underscores should be used in function and variable names?
There was a problem hiding this comment.
Should this also say that underscores should be used in function and variable names?
In Python, hyphens are not allowed in function and variable names. So we have to use underscores when function and variable names are long.
There was a problem hiding this comment.
Did not know that! Thanks!
seisman
added
the
final review call
willschlitzer
approved these changes
Dec 13, 2022
seisman
removed
the
final review call
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
Sometimes we may forget and use hyphens, for example #2245.
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 commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version