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 for makecpt
  • Loading branch information
weiji14 committed Jun 2, 2020
commit 2223ae237dc6dfeddd2489ff2ffb35ea7fb656d7
24 changes: 12 additions & 12 deletions pygmt/mathops.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,38 +19,38 @@ def makecpt(**kwargs):

Parameters
----------
cmap (C) : str
cmap : str
Selects the master color palette table (CPT) to use in the
interpolation. Full list of built-in color palette tables can be found
at :gmt-docs:`cookbook/cpts.html#built-in-color-palette-tables-cpt`.
series (T) : list or str
series : list or str
``[min/max/inc[+b|l|n]|file|list]``. Defines the range of the new CPT
by giving the lowest and highest z-value (and optionally an interval).
If this is not given, the existing range in the master CPT will be used
intact.
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 any
resampling. See also
:gmt-docs:`cookbook/features.html#manipulating-cpts`.
output (H) : str
output : str
Optional. The file name with extension .cpt to store the generated CPT
file. If not given or False (default), saves the CPT as the session
current CPT.
reverse (I) : str
reverse : str
Set this to True or c [Default] to reverse the sense of color
progression in the master CPT. Set this to z to reverse the sign of
z-values in the color table. Note that this change of z-direction
happens before -G and -T values are used so the latter must be
compatible with the changed z-range. See also
happens before *truncate* and *series* values are used so the latter
must be compatible with the changed z-range. See also
:gmt-docs:`cookbook/features.html#manipulating-cpts`.
continuous (Z) : bool
continuous : bool
Creates a continuous CPT [Default is discontinuous, i.e., constant
colors for each interval]. This option has no effect when no -T is
used, or when using -Tz_min/z_max; in the first case the input CPT
remains untouched, in the second case it is only scaled to match the
range z_min/z_max.
colors for each interval]. This option has no effect when no *series*
is used, or when using *series=[z_min, z_max]*; in the first case the
input CPT remains untouched, in the second case it is only scaled to
match the range z_min/z_max.

"""
with Session() as lib:
Expand Down