-
Notifications
You must be signed in to change notification settings - Fork 224
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Expand documentation for Cartesian projections #2643
Merged
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
yvonnefroehlich
added
documentation
Improvements or additions to documentation
skip-changelog
Skip adding Pull Request to changelog
labels
Aug 25, 2023
7 tasks
yvonnefroehlich
changed the title
Expand documentation for Cartesian projections
WIP: Expand documentation for Cartesian projections
Aug 25, 2023
yvonnefroehlich
changed the title
WIP: Expand documentation for Cartesian projections
Expand documentation for Cartesian projections
Aug 25, 2023
michaelgrund
approved these changes
Aug 26, 2023
michaelgrund
approved these changes
Aug 27, 2023
yvonnefroehlich
added
the
needs review
This PR has higher priority and needs review.
label
Aug 27, 2023
seisman
approved these changes
Aug 28, 2023
seisman
added
final review call
This PR requires final review and approval from a second reviewer
and removed
needs review
This PR has higher priority and needs review.
labels
Aug 28, 2023
weiji14
removed
the
final review call
This PR requires final review and approval from a second reviewer
label
Aug 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
skip-changelog
Skip adding Pull Request to changelog
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
This PR aims to expand the documentations of the Cartesian linear, logarithmic, and power projections regarding the scale option.
Currently, the general syntax is repeated for the scale option (lower-case letter version), as we have it for nearly all other projections. Or do we only want to state the width-height version (upper-case letter version), as is currently done for the polar projection?
For context / first mentioned: #2641 (comment)
Preview:
Reminders
make format
andmake check
to 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