-
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
Add common aliases xshift (X) and yshift (Y) #624
Conversation
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
"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`. | ||
""", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 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:
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 format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.