Add common aliases xshift (X) and yshift (Y)#624
Merged
Conversation
Member
A single
All common aliases (e.g., region, projection) are using a simplified docstring. We should follow the convention for X and Y, but we may need to find a better way linking to the full documentation. |
Also added link to full documentation of xshift/yshift at https://docs.generic-mapping-tools.org/latest/gmt.html#xy-full
24 tasks
weiji14
commented
Sep 21, 2020
Comment on lines
+56
to
+64
| "XY": """\ | ||
| xshift : str | ||
| ``[a|c|f|r][xshift]``. | ||
| Shift plot origin in x-direction. | ||
| yshift : str | ||
| ``[a|c|f|r][yshift]``. | ||
| Shift plot origin in y-direction. Full documentation is at | ||
| :gmt-docs:`gmt.html#xy-full`. | ||
| """, |
Member
Author
There was a problem hiding this comment.
- Do we want a) full documentation from https://docs.generic-mapping-tools.org/6.1/gmt.html#xy-full, or b) just the simplified shortened docsting found at https://docs.generic-mapping-tools.org/6.1/std-opts.html?
All common aliases (e.g., region, projection) are using a simplified docstring. We should follow the convention for X and Y, but we may need to find a better way linking to the full documentation.
Ok, sticking with the simplified docstring, and added a link to the full documentation. Below is how it looks like rendered, let me know if we should expand this a little bit more:
seisman
approved these changes
Sep 21, 2020
This was referenced Oct 22, 2020
Closed
Merged
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
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
Used for shifting plots along the x and y dimensions. See https://docs.generic-mapping-tools.org/6.1/gmt.html#xy-full.
Live documentation preview for this PR/branch is at https://pygmt-git-common-aliases-xy.gmt.vercel.app/api/generated/pygmt.Figure.plot.html
Note that the xshift/yshift names follow upstream GMT long option name conventions at https://github.com/GenericMappingTools/gmt/blob/88421f9f8fe9759692302905268f4036b287adcb/src/gmt_init.c#L393-L394
Details to address:
{X}and{Y}entries, or a single{XY}entry?See related issue at #380. This PR will be a part of #620 too.
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.