Use "general" verb form in docstrings #2376
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
yvonnefroehlich
added
documentation
|
No guarantee I found all occurrences... Thanks for reviewing this PR. @GenericMappingTools/pygmt-maintainers should there be a separate PR for the other docstring changes in this PR or is leaving these changes in this PR fine? |
yvonnefroehlich
added
the
needs review
yvonnefroehlich
changed the title
seisman
approved these changes
Mar 11, 2023
seisman
added
final review call
michaelgrund
approved these changes
Mar 11, 2023
pygmt/src/meca.py
Outdated
| @@ -231,8 +231,9 @@ def meca( | |||
| determined by the z-value (i.e., event depth or the third column for | |||
| an input file). | |||
| no_clip : bool | |||
| Does NOT skip symbols that fall outside frame boundary specified by | |||
| ``region`` [Default is False, i.e. plot symbols inside map frame only]. | |||
| Do NOT skip symbols that fall outside frame boundary specified by | |||
There was a problem hiding this comment.
Suggested change
| Do NOT skip symbols that fall outside frame boundary specified by | |
| Do NOT skip symbols that fall outside the frame boundary specified by |
There was a problem hiding this comment.
@michaelgrund in commit 2f94dd5 I tried to make the docstrings for no_clip more consistent across the single methods.
seisman
removed
the
final review call
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 aims to use more consistently the "general" verb form in the docstrings.
Fixes: #2345 (comment)
Related to GMT upstream documentation: GenericMappingTools/gmt@a57fd6c, GenericMappingTools/gmt@8256073
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