Update the docstrings of common aliases#862
Merged
willschlitzer merged 1 commit intomasterfrom Feb 12, 2021
Merged
Conversation
seisman
commented
Feb 11, 2021
92e5c30 to
f1ac8ce
Compare
f48cb83 to
692f167
Compare
692f167 to
b20a1df
Compare
b20a1df to
32850c3
Compare
Member
Author
|
This PR is ready for review, but it seems something wrong with Vercel, so the documentation is not available for preview yet. |
Contributor
|
I agree that my pull request (#783) makes the code hard to read! |
willschlitzer
approved these changes
Feb 12, 2021
Contributor
willschlitzer
left a comment
There was a problem hiding this comment.
Looks good! It seems to have deployed fine, and I checked at least one page for each of the aliases with no issues.
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
Update the docstrings of the aliases in COMMON_OPTIONS in decorators.py
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
3 participants
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
Update the docstrings of common aliases following the convenction in #631.
This PR is different from PR #783.
I feel that the changes in PR #783 make COMMON_OPTIONS difficult to read:
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