Skip to content

Commit 0be992e

Browse files
authored
Figure.plot: Deprecate parameter "columns" to "incols" (remove in v0.6.0)
As discussed in #764, this PR replaces the **columns** parameter by **incols** for plot.py and adds the deprecation .
1 parent f7a9e5e commit 0be992e

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

pygmt/src/plot.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
Y="yshift",
3737
Z="zvalue",
3838
a="aspatial",
39-
i="columns",
39+
i="incols",
4040
l="label",
4141
c="panel",
4242
f="coltypes",
@@ -45,6 +45,7 @@
4545
)
4646
@kwargs_to_strings(R="sequence", c="sequence_comma", i="sequence_comma", p="sequence")
4747
@deprecate_parameter("sizes", "size", "v0.4.0", remove_version="v0.6.0")
48+
@deprecate_parameter("columns", "incols", "v0.4.0", remove_version="v0.6.0")
4849
def plot(self, x=None, y=None, data=None, size=None, direction=None, **kwargs):
4950
r"""
5051
Plot lines, polygons, and symbols in 2-D.
@@ -192,10 +193,10 @@ def plot(self, x=None, y=None, data=None, size=None, direction=None, **kwargs):
192193
{a}
193194
{c}
194195
{f}
195-
columns : str or 1d array
196+
incols : str or 1d array
196197
Choose which columns are x, y, color, and size, respectively if
197-
input is provided via *data*. E.g. ``columns = [0, 1]`` or
198-
``columns = '0,1'`` if the *x* values are stored in the first
198+
input is provided via *data*. E.g. ``incols = [0, 1]`` or
199+
``incols = '0,1'`` if the *x* values are stored in the first
199200
column and *y* values in the second one. Note: zero-based
200201
indexing is used.
201202
label : str

0 commit comments

Comments
 (0)