Skip to content

Add common aliases xshift (X) and yshift (Y) #624

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.

Sign up for GitHub

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

Merged
weiji14 merged 5 commits into from
Sep 21, 2020
Merged

Add common aliases xshift (X) and yshift (Y) #624

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8a99a1f
Add common alias xshift (X) and yshift (Y) to decorators.py
weiji14 Sep 20, 2020
72f9ae2
Add common alias xshift (X) and yshift (Y) to plot
weiji14 Sep 20, 2020
0e87164
Merge branch 'master' into common-aliases/XY
weiji14 Sep 21, 2020
a911bd3
Merge {X} and {Y} into a single {XY} common option
weiji14 Sep 21, 2020
854b2e6
Add xshift/yshift long alias to all plotting functions
weiji14 Sep 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions pygmt/base_plotting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,8 @@ def grdview(self, grid, **kwargs):
l="label",
C="cmap",
U="timestamp",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence", i="sequence_comma")
Expand Down Expand Up @@ -546,6 +548,7 @@ def plot(self, x=None, y=None, data=None, sizes=None, direction=None, **kwargs):
quoted lines).
{W}
{U}
{XY}
label : str
Add a legend entry for the symbol or line being plotted.

Expand Down
9 changes: 9 additions & 0 deletions pygmt/helpers/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@
"W": """\
pen : str
Set pen attributes for lines or the outline of symbols.""",
"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`.
""",
Comment on lines +56 to +64
Copy link
Member Author

@weiji14 weiji14 Sep 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. 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:

xshift yshift minimal docs with link to gmt manpage

"j": """\
distcalc : str
``e|f|g``.
Expand Down