Improve the docstring of the pygmt package #1016
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
Based on #1012, here's a first suggestion for improving the docstring which is displayed when running ``import pygmt`` followed by ``help(pygmt)``.
|
/format |
|
Do we need the |
|
/format |
seisman
reviewed
Mar 7, 2021
core-man
reviewed
Mar 7, 2021
core-man
reviewed
Mar 7, 2021
core-man
reviewed
Mar 7, 2021
seisman
reviewed
Mar 8, 2021
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
|
Great~ I think it's good. |
maxrjones
approved these changes
Mar 9, 2021
Co-authored-by: Meghan Jones <[email protected]>
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Yao Jiayuan <[email protected]> Co-authored-by: Meghan Jones <[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.
Based on #1012, here's a first suggestion (partly influced by the pandas docstring) for improving the docstring which is displayed when running
import pygmtfollowed byhelp(pygmt). Open for discussions, improvements and other ideas.Description of proposed changes
Fixes #
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