Skip to content
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

Turn all short aliases into long form #474

Merged
merged 25 commits into from
Jun 4, 2020
Merged
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
c75d2d1
Turn common aliases from short form to long form
weiji14 Jun 1, 2020
1e14b72
Fix fmt_docstring test
weiji14 Jun 1, 2020
144effa
Alias U as timestamp instead of logo
weiji14 Jun 1, 2020
2223ae2
Remove short aliases for makecpt
weiji14 Jun 2, 2020
f5fc1a3
Remove short aliases for surface
weiji14 Jun 2, 2020
8906d59
Add common alias interpolation (n) for grdtrack
weiji14 Jun 2, 2020
db842e7
Remove short alias for which and refactor test
weiji14 Jun 2, 2020
71fb973
Remove short aliases from coast
seisman Jun 2, 2020
f131cd5
Remove short aliases from colorbar
seisman Jun 2, 2020
57f25ea
Improve docstring of colorbar
seisman Jun 2, 2020
ce6e84f
Remove short aliases from grdcontour
seisman Jun 2, 2020
cb5fb41
Remove short aliases from legend
seisman Jun 2, 2020
ac6aad3
Remove short aliases for logo
seisman Jun 2, 2020
52b8d0c
Aliased per_column(C), spacing(I), nearest_multiple(T) for info
weiji14 Jun 3, 2020
aa369dc
Remove short aliases for psconvert and improve fmt docstring
weiji14 Jun 3, 2020
718e786
Add U to docstring of grdcontour
seisman Jun 3, 2020
b8f7b33
Remove short aliases for plot
seisman Jun 3, 2020
30136d5
Remove short aliases for contour
seisman Jun 3, 2020
c320756
Improve docstring of text
weiji14 Jun 3, 2020
d9a3290
Remove short alias from image
weiji14 Jun 3, 2020
d87b7e4
Use frame instead of B for basemap.
weiji14 Jun 3, 2020
e3b5183
Fix a typo "book"->"bool"
seisman Jun 3, 2020
15b9c6b
Alias map_scale(L), rose(Td), compass(Tm) for basemap
weiji14 Jun 3, 2020
a1f5839
Change x, y to x/y in docstrings to make it look nicer
weiji14 Jun 4, 2020
8869feb
Fix string to str in docstrings
seisman Jun 4, 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
Prev Previous commit
Next Next commit
Remove short aliases from colorbar
  • Loading branch information
seisman committed Jun 2, 2020
commit f131cd5ba0011c98a72cde9b637b8d650c8c4e3a
8 changes: 4 additions & 4 deletions pygmt/base_plotting.py
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ def colorbar(self, **kwargs):

Parameters
----------
position (D) : str
position : str
``[g|j|J|n|x]refpoint[+wlength[/width]][+e[b|f][length]][+h|v]
[+jjustify][+m[a|c|l|u]][+n[txt]][+odx[/dy]]``. Defines the
reference point on the map for the color scale using one of four
Expand All @@ -183,7 +183,7 @@ def colorbar(self, **kwargs):
default, the anchor point on the scale is assumed to be the bottom
left corner (BL), but this can be changed by appending +j followed
by a 2-char justification code justify.
box (F) : bool or str
box : bool or str
``[+cclearances][+gfill][+i[[gap/]pen]][+p[pen]][+r[radius]]
[+s[[dx/dy/][shade]]]``. If set to True, draws a rectangular
border around the color scale. Alternatively, specify a different
Expand All @@ -199,12 +199,12 @@ def colorbar(self, **kwargs):
offset background shaded region. Here, dx/dy indicates the shift
relative to the foreground frame [4p/-4p] and shade sets the fill
style to use for shading [gray50].
truncate (G) : list or str
truncate : list or str
``zlo/zhi`` Truncate the incoming CPT so that the lowest and
highest z-levels are to zlo and zhi. If one of these equal NaN then
we leave that end of the CPT alone. The truncation takes place
before the plotting.
scale (W) : float
scale : float
Multiply all z-values in the CPT by the provided scale. By default
the CPT is used as is.

Expand Down