Skip to content

Commit 998a123

Browse files
committed
Let all functions support tab autocompletion
1 parent 0469d09 commit 998a123

30 files changed

+550
-30
lines changed

pygmt/figure.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,17 @@ def region(self):
132132
Q="anti_aliasing",
133133
)
134134
@kwargs_to_strings()
135-
def psconvert(self, **kwargs):
135+
def psconvert(
136+
self,
137+
crop=None,
138+
gs_option=None,
139+
dpi=None,
140+
prefix=None,
141+
icc_gray=None,
142+
fmt=None,
143+
anti_aliasing=None,
144+
**kwargs,
145+
):
136146
r"""
137147
Convert [E]PS file(s) to other formats.
138148

pygmt/src/basemap.py

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,26 @@
3333
t="transparency",
3434
)
3535
@kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
36-
def basemap(self, **kwargs):
36+
def basemap(
37+
self,
38+
region=None,
39+
projection=None,
40+
zscale=None,
41+
zsize=None,
42+
frame=None,
43+
map_scale=None,
44+
rose=None,
45+
compass=None,
46+
timestamp=None,
47+
verbose=None,
48+
xshift=None,
49+
yshift=None,
50+
panel=None,
51+
coltypes=None,
52+
perspective=None,
53+
transparency=None,
54+
**kwargs
55+
):
3756
r"""
3857
Plot base maps and frames for the figure.
3958

pygmt/src/blockm.py

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,17 @@ def _blockm(block_method, table, outfile, **kwargs):
8080
r="registration",
8181
)
8282
@kwargs_to_strings(R="sequence")
83-
def blockmean(table, outfile=None, **kwargs):
83+
def blockmean(
84+
table,
85+
outfile=None,
86+
spacing=None,
87+
region=None,
88+
verbose=None,
89+
aspatial=None,
90+
coltypes=None,
91+
registration=None,
92+
**kwargs,
93+
):
8494
r"""
8595
Block average (x,y,z) data tables by mean estimation.
8696
@@ -141,7 +151,17 @@ def blockmean(table, outfile=None, **kwargs):
141151
r="registration",
142152
)
143153
@kwargs_to_strings(R="sequence")
144-
def blockmedian(table, outfile=None, **kwargs):
154+
def blockmedian(
155+
table,
156+
outfile=None,
157+
spacing=None,
158+
region=None,
159+
verbose=None,
160+
aspatial=None,
161+
coltypes=None,
162+
registration=None,
163+
**kwargs,
164+
):
145165
r"""
146166
Block average (x,y,z) data tables by median estimation.
147167

pygmt/src/coast.py

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,30 @@
3737
t="transparency",
3838
)
3939
@kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
40-
def coast(self, **kwargs):
40+
def coast(
41+
self,
42+
region=None,
43+
projection=None,
44+
area_thresh=None,
45+
lakes=None,
46+
frame=None,
47+
resolution=None,
48+
dcw=None,
49+
rivers=None,
50+
map_scale=None,
51+
borders=None,
52+
shorelines=None,
53+
land=None,
54+
water=None,
55+
timestamp=None,
56+
verbose=None,
57+
xshift=None,
58+
yshift=None,
59+
panel=None,
60+
perspective=None,
61+
transparency=None,
62+
**kwargs
63+
):
4164
r"""
4265
Plot continents, shorelines, rivers, and borders on maps
4366

pygmt/src/colorbar.py

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,25 @@
2727
@kwargs_to_strings(
2828
R="sequence", G="sequence", I="sequence", c="sequence_comma", p="sequence"
2929
)
30-
def colorbar(self, **kwargs):
30+
def colorbar(
31+
self,
32+
region=None,
33+
projection=None,
34+
frame=None,
35+
cmap=None,
36+
position=None,
37+
box=None,
38+
truncate=None,
39+
shading=None,
40+
scale=None,
41+
verbose=None,
42+
xshift=None,
43+
yshift=None,
44+
panel=None,
45+
perspective=None,
46+
transparency=None,
47+
**kwargs
48+
):
3149
r"""
3250
Plot a gray or color scale-bar on maps.
3351

pygmt/src/contour.py

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,32 @@
3636
t="transparency",
3737
)
3838
@kwargs_to_strings(R="sequence", c="sequence_comma", i="sequence_comma", p="sequence")
39-
def contour(self, x=None, y=None, z=None, data=None, **kwargs):
39+
def contour(
40+
self,
41+
x=None,
42+
y=None,
43+
z=None,
44+
data=None,
45+
annotation=None,
46+
frame=None,
47+
levels=None,
48+
label_placement=None,
49+
projection=None,
50+
triangular_mesh_pen=None,
51+
no_clip=None,
52+
region=None,
53+
skip=None,
54+
verbose=None,
55+
pen=None,
56+
xshift=None,
57+
yshift=None,
58+
panel=None,
59+
columns=None,
60+
label=None,
61+
perspective=None,
62+
transparency=None,
63+
**kwargs
64+
):
4065
r"""
4166
Contour table data by direct triangulation.
4267

pygmt/src/grd2cpt.py

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,28 @@
2929
Z="continuous",
3030
)
3131
@kwargs_to_strings(G="sequence", L="sequence", R="sequence", T="sequence")
32-
def grd2cpt(grid, **kwargs):
32+
def grd2cpt(
33+
grid,
34+
transparency=None,
35+
cmap=None,
36+
background=None,
37+
color_model=None,
38+
nlevels=None,
39+
truncate=None,
40+
output=None,
41+
reverse=None,
42+
limit=None,
43+
overrule_bg=None,
44+
no_bg=None,
45+
log=None,
46+
region=None,
47+
series=None,
48+
verbose=None,
49+
categorical=None,
50+
cyclic=None,
51+
continuous=None,
52+
**kwargs,
53+
):
3354
r"""
3455
Make GMT color palette tables from a grid file.
3556

pygmt/src/grdcontour.py

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,30 @@
3030
@kwargs_to_strings(
3131
R="sequence", L="sequence", A="sequence_plus", c="sequence_comma", p="sequence"
3232
)
33-
def grdcontour(self, grid, **kwargs):
33+
def grdcontour(
34+
self,
35+
grid,
36+
annotation=None,
37+
frame=None,
38+
interval=None,
39+
label_placement=None,
40+
projection=None,
41+
limit=None,
42+
cut=None,
43+
region=None,
44+
resample=None,
45+
timestamp=None,
46+
verbose=None,
47+
pen=None,
48+
label=None,
49+
xshift=None,
50+
yshift=None,
51+
panel=None,
52+
coltypes=None,
53+
perspective=None,
54+
transparency=None,
55+
**kwargs
56+
):
3457
r"""
3558
Convert grids or images to contours and plot them on maps.
3659

pygmt/src/grdcut.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,18 @@
2525
f="coltypes",
2626
)
2727
@kwargs_to_strings(R="sequence")
28-
def grdcut(grid, **kwargs):
28+
def grdcut(
29+
grid,
30+
outgrid=None,
31+
region=None,
32+
projection=None,
33+
extend=None,
34+
circ_subregion=None,
35+
verbose=None,
36+
z_subregion=None,
37+
coltypes=None,
38+
**kwargs
39+
):
2940
r"""
3041
Extract subregion from a grid.
3142

pygmt/src/grdfilter.py

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,20 @@
2727
r="registration",
2828
)
2929
@kwargs_to_strings(R="sequence")
30-
def grdfilter(grid, **kwargs):
30+
def grdfilter(
31+
grid,
32+
distance=None,
33+
filter=None,
34+
outgrid=None,
35+
spacing=None,
36+
nans=None,
37+
region=None,
38+
toggle=None,
39+
verbose=None,
40+
coltypes=None,
41+
registration=None,
42+
**kwargs
43+
):
3144
r"""
3245
Filter a grid in the space (or time) domain.
3346

pygmt/src/grdimage.py

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,33 @@
3131
x="cores",
3232
)
3333
@kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
34-
def grdimage(self, grid, **kwargs):
34+
def grdimage(
35+
self,
36+
grid,
37+
img_out=None,
38+
frame=None,
39+
cmap=None,
40+
img_in=None,
41+
dpi=None,
42+
bit_color=None,
43+
shading=None,
44+
projection=None,
45+
monochrome=None,
46+
no_clip=None,
47+
nan_transparent=None,
48+
region=None,
49+
timestamp=None,
50+
verbose=None,
51+
xshift=None,
52+
yshift=None,
53+
interpolation=None,
54+
panel=None,
55+
coltypes=None,
56+
perspective=None,
57+
transparency=None,
58+
cores=None,
59+
**kwargs
60+
):
3561
r"""
3662
Project and plot grids or images.
3763

pygmt/src/grdinfo.py

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,20 @@
2525
f="coltypes",
2626
)
2727
@kwargs_to_strings(D="sequence", I="sequence", R="sequence")
28-
def grdinfo(grid, **kwargs):
28+
def grdinfo(
29+
grid,
30+
per_column=None,
31+
tiles=None,
32+
geographic=None,
33+
spacing=None,
34+
force_scan=None,
35+
minmax_pos=None,
36+
region=None,
37+
nearest_multiple=None,
38+
verbose=None,
39+
coltypes=None,
40+
**kwargs
41+
):
2942
r"""
3043
Get information about a grid.
3144

pygmt/src/grdtrack.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,16 @@
1616

1717
@fmt_docstring
1818
@use_alias(V="verbose", f="coltypes", n="interpolation")
19-
def grdtrack(points, grid, newcolname=None, outfile=None, **kwargs):
19+
def grdtrack(
20+
points,
21+
grid,
22+
newcolname=None,
23+
outfile=None,
24+
verbose=None,
25+
coltypes=None,
26+
interpolation=None,
27+
**kwargs,
28+
):
2029
"""
2130
Sample grids at specified (x,y) locations.
2231

pygmt/src/grdview.py

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,31 @@
3838
t="transparency",
3939
)
4040
@kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
41-
def grdview(self, grid, **kwargs):
41+
def grdview(
42+
self,
43+
grid,
44+
region=None,
45+
projection=None,
46+
zscale=None,
47+
zsize=None,
48+
frame=None,
49+
cmap=None,
50+
drapegrid=None,
51+
plane=None,
52+
surftype=None,
53+
contourpen=None,
54+
meshpen=None,
55+
facadepen=None,
56+
shading=None,
57+
verbose=None,
58+
xshift=None,
59+
yshift=None,
60+
panel=None,
61+
coltypes=None,
62+
perspective=None,
63+
transparency=None,
64+
**kwargs,
65+
):
4266
r"""
4367
Create 3-D perspective image or surface mesh from a grid.
4468

0 commit comments

Comments
 (0)