Skip to content

Commit b47ab35

Browse files
committed
Document common aliases for grdimage
Add automatic docstrings for frame (B), cmap (C), projection (J), region (R), timestamp (U), verbose (V), and interpolation (n). Also removed alias pen (W) that actually doesn't work.
1 parent 4e4dbbc commit b47ab35

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

pygmt/base_plotting.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -303,12 +303,14 @@ def grdcontour(self, grid, **kwargs):
303303

304304
@fmt_docstring
305305
@use_alias(
306-
R="region",
307-
J="projection",
308-
W="pen",
309306
B="frame",
310-
I="shading",
311307
C="cmap",
308+
I="shading",
309+
J="projection",
310+
R="region",
311+
U="timestamp",
312+
V="verbose",
313+
n="interpolation",
312314
t="transparency",
313315
)
314316
@kwargs_to_strings(R="sequence")
@@ -326,6 +328,12 @@ def grdimage(self, grid, **kwargs):
326328
----------
327329
grid : str or xarray.DataArray
328330
The file name of the input grid or the grid loaded as a DataArray.
331+
{B}
332+
{CPT}
333+
{J}
334+
{R}
335+
{V}
336+
{n}
329337
{t}
330338
331339
"""

0 commit comments

Comments
 (0)