Update region and projection standard docstrings #1510
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
seisman
reviewed
Sep 15, 2021
|
The doctest in pygmt/pygmt/helpers/decorators.py Line 451 in c81555e *Required if this is the first plot command*. from the fmt_docstring doctest.
|
weiji14
approved these changes
Oct 8, 2021
weiji14
added
the
final review call
maxrjones
reviewed
Oct 8, 2021
seisman
approved these changes
Oct 9, 2021
Co-authored-by: Meghan Jones <[email protected]>
maxrjones
approved these changes
Oct 11, 2021
weiji14
removed
the
final review call
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
…#1510) Modify the COMMON_OPTIONS text for region and projection to remove the "Required if this is the first plot command" text, but adding it solely to `basemap`, `coast` and `text` where it is actually required. 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.
This pull request modifies the COMMON_OPTIONS text for
regionandprojection. It also adds that it is requirement for certain plotting commands to individual modules. This partially addresses #1493.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