Skip to content

Commit 02858eb

Browse files
author
Meghan Jones
authored
Add alias annotation (A) to Figure.contour() (#883)
1 parent 57fcc4f commit 02858eb

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

pygmt/src/contour.py

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,36 +16,35 @@
1616

1717
@fmt_docstring
1818
@use_alias(
19-
R="region",
20-
J="projection",
19+
A="annotation",
2120
B="frame",
22-
S="skip",
21+
C="levels",
2322
G="label_placement",
24-
W="pen",
23+
J="projection",
2524
L="triangular_mesh_pen",
2625
N="no_clip",
27-
i="columns",
28-
l="label",
29-
C="levels",
26+
R="region",
27+
S="skip",
3028
V="verbose",
29+
W="pen",
3130
X="xshift",
3231
Y="yshift",
3332
c="panel",
33+
i="columns",
34+
l="label",
3435
p="perspective",
3536
t="transparency",
3637
)
3738
@kwargs_to_strings(R="sequence", c="sequence_comma", i="sequence_comma", p="sequence")
3839
def contour(self, x=None, y=None, z=None, data=None, **kwargs):
39-
"""
40+
r"""
4041
Contour table data by direct triangulation.
4142
4243
Takes a matrix, (x,y,z) pairs, or a file name as input and plots lines,
4344
polygons, or symbols at those locations on a map.
4445
4546
Must provide either *data* or *x*, *y*, and *z*.
4647
47-
[TODO: Insert more documentation]
48-
4948
Full option list at :gmt-docs:`contour.html`
5049
5150
{aliases}
@@ -58,10 +57,12 @@ def contour(self, x=None, y=None, z=None, data=None, **kwargs):
5857
Either a data file name or a 2d numpy array with the tabular data.
5958
{J}
6059
{R}
61-
A : bool or str
62-
``'[m|p|x|y]'``
63-
By default, geographic line segments are drawn as great circle
64-
arcs. To draw them as straight lines, use *A*.
60+
annotation : str or int
61+
Specify or disable annotated contour levels, modifies annotated
62+
contours specified in ``interval``.
63+
64+
- Specify a fixed annotation interval *annot_int* or a
65+
single annotation level +\ *annot_int*.
6566
{B}
6667
levels : str
6768
Contour file or level(s)

0 commit comments

Comments
 (0)