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
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 all 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
39 changes: 39 additions & 0 deletions pygmt/base_plotting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ def _preprocess(self, **kwargs): # pylint: disable=no-self-use
G="land",
S="water",
U="timestamp",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence")
Expand Down Expand Up @@ -129,6 +131,7 @@ def coast(self, **kwargs):
shorelines : str
``'[level/]pen'``
Draw shorelines [Default is no shorelines]. Append pen attributes.
{XY}
{t}

"""
Expand All @@ -146,6 +149,8 @@ def coast(self, **kwargs):
F="box",
G="truncate",
W="scale",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence", G="sequence")
Expand Down Expand Up @@ -208,6 +213,7 @@ def colorbar(self, **kwargs):
scale : float
Multiply all z-values in the CPT by the provided scale. By default
the CPT is used as is.
{XY}
{t}

"""
Expand All @@ -229,6 +235,8 @@ def colorbar(self, **kwargs):
U="timestamp",
W="pen",
l="label",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence", L="sequence", A="sequence_plus")
Expand Down Expand Up @@ -279,6 +287,7 @@ def grdcontour(self, grid, **kwargs):
{G}
{U}
{W}
{XY}
label : str
Add a legend entry for the contour being plotted. Normally, the
annotated contour is selected for the legend. You can select the
Expand Down Expand Up @@ -309,6 +318,8 @@ def grdcontour(self, grid, **kwargs):
B="frame",
I="shading",
C="cmap",
X="xshift",
Y="yshift",
t="transparency",
x="cores",
)
Expand All @@ -327,6 +338,7 @@ def grdimage(self, grid, **kwargs):
----------
grid : str or xarray.DataArray
The file name of the input grid or the grid loaded as a DataArray.
{XY}
{t}
{x}

Expand Down Expand Up @@ -360,6 +372,8 @@ def grdimage(self, grid, **kwargs):
Wf="facadepen",
p="perspective",
I="shading",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence", p="sequence")
Expand Down Expand Up @@ -437,6 +451,7 @@ def grdview(self, grid, **kwargs):
intensity, and ambient arguments for that module, or just give
``+d`` to select the default arguments (``+a-45+nt1+m0``).

{XY}
{t}

"""
Expand Down Expand Up @@ -478,6 +493,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 +563,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 Expand Up @@ -599,6 +617,8 @@ def plot(self, x=None, y=None, data=None, sizes=None, direction=None, **kwargs):
i="columns",
l="label",
C="levels",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence", i="sequence_comma")
Expand Down Expand Up @@ -657,6 +677,7 @@ def contour(self, x=None, y=None, z=None, data=None, **kwargs):
to be of the format [*annotcontlabel*][/*contlabel*]. If either
label contains a slash (/) character then use ``|`` as the
separator for the two labels instead.
{XY}
{t}

"""
Expand Down Expand Up @@ -688,6 +709,8 @@ def contour(self, x=None, y=None, z=None, data=None, **kwargs):
Td="rose",
Tm="compass",
U="timestamp",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence")
Expand Down Expand Up @@ -722,6 +745,7 @@ def basemap(self, **kwargs):
Draws a map magnetic rose on the map at the location defined by the
reference and anchor points
{U}
{XY}
{t}

"""
Expand All @@ -738,6 +762,8 @@ def basemap(self, **kwargs):
U="timestamp",
D="position",
F="box",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence")
Expand Down Expand Up @@ -765,6 +791,7 @@ def logo(self, **kwargs):
Without further options, draws a rectangular border around the
GMT logo.
{U}
{XY}
{t}

"""
Expand All @@ -781,6 +808,8 @@ def logo(self, **kwargs):
D="position",
F="box",
M="monochrome",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence")
Expand Down Expand Up @@ -816,6 +845,7 @@ def image(self, imagefile, **kwargs):
monochrome : bool
Convert color image to monochrome grayshades using the (television)
YIQ-transformation.
{XY}
{t}
"""
kwargs = self._preprocess(**kwargs)
Expand All @@ -829,6 +859,8 @@ def image(self, imagefile, **kwargs):
J="projection",
D="position",
F="box",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence")
Expand Down Expand Up @@ -865,6 +897,7 @@ def legend(self, spec=None, position="JTR+jTR+o0.2c", box="+gwhite+p1p", **kwarg
rectangular border around the legend using **MAP_FRAME_PEN**. By
default, uses '+gwhite+p1p' which draws a box around the legend
using a 1 point black pen and adds a white background.
{XY}
{t}
"""
kwargs = self._preprocess(**kwargs)
Expand Down Expand Up @@ -894,6 +927,8 @@ def legend(self, spec=None, position="JTR+jTR+o0.2c", box="+gwhite+p1p", **kwarg
D="offset",
G="fill",
W="pen",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(
Expand Down Expand Up @@ -1000,6 +1035,7 @@ def text(
Sets the pen used to draw a rectangle around the text string
(see *clearance*) [Default is width = default, color = black,
style = solid].
{XY}
{t}
"""
kwargs = self._preprocess(**kwargs)
Expand Down Expand Up @@ -1055,6 +1091,8 @@ def text(
J="projection",
B="frame",
C="offset",
X="xshift",
Y="yshift",
t="transparency",
)
@kwargs_to_strings(R="sequence")
Expand Down Expand Up @@ -1152,6 +1190,7 @@ def meca(
{J}
{R}
{B}
{XY}
{t}
"""

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

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