docs: Use consistent description for the 'outgrid' parameter#2874
Merged
docs: Use consistent description for the 'outgrid' parameter#2874
Conversation
fc20ed3 to
c0921af
Compare
michaelgrund
approved these changes
Dec 14, 2023
yvonnefroehlich
approved these changes
Dec 14, 2023
Member
|
This is not directly related to this PR, but I am wondering why there is sometimes a blank line between the docstrings of two parameters and sometimes not (the example is from Lines 51 to 56 in ec22b0c |
This file contains hidden or 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
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
Preview: https://pygmt-dev--2874.org.readthedocs.build/en/2874/api/generated/pygmt.grdclip.html#pygmt.grdclip
Fixes #2695
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