Update the doc strings in the non-plotting modules #882
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
maxrjones
reviewed
Feb 13, 2021
seisman
reviewed
Feb 13, 2021
maxrjones
reviewed
Feb 13, 2021
Co-authored-by: Meghan Jones <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>
|
@meghanrjones @seisman Thank you for the thorough feedback! |
|
@willschlitzer please try your best to update the documentation following #886 |
seisman
reviewed
Feb 14, 2021
Co-authored-by: Dongdong Tian <[email protected]>
seisman
reviewed
Feb 14, 2021
Co-authored-by: Dongdong Tian <[email protected]>
seisman
approved these changes
Feb 14, 2021
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
…s#882) * Update docstrings for makecpt.py * Update docstrings for savefig in figure.py * Update docstrings for psconvert in figure.py * Update docstrings in blockmedian.py * Update docstrings in surface.py * Update docstrings in grdcut.py * Update docstrings in grdfilter.py * Update docstrings in x2sys.py * Update docstrings for x2sys_cross in x2sys.py * Update docstrings for info.py * Update output docstring in info.py * Update formatting in makecpt.py Co-authored-by: Meghan Jones <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>
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.
As mentioned in #881, this is an update to the doc strings of the non-plotting functions to be standardized according to #631.
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