From 0be992e2aba6c21c739a299dbf8f40da72ea3dc0 Mon Sep 17 00:00:00 2001 From: Michael Grund <23025878+michaelgrund@users.noreply.github.com> Date: Wed, 26 May 2021 08:37:26 +0200 Subject: [PATCH] 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 . --- pygmt/src/plot.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py index 1bd6e314261..f9f2be9fd0a 100644 --- a/pygmt/src/plot.py +++ b/pygmt/src/plot.py @@ -36,7 +36,7 @@ Y="yshift", Z="zvalue", a="aspatial", - i="columns", + i="incols", l="label", c="panel", f="coltypes", @@ -45,6 +45,7 @@ ) @kwargs_to_strings(R="sequence", c="sequence_comma", i="sequence_comma", p="sequence") @deprecate_parameter("sizes", "size", "v0.4.0", remove_version="v0.6.0") +@deprecate_parameter("columns", "incols", "v0.4.0", remove_version="v0.6.0") def plot(self, x=None, y=None, data=None, size=None, direction=None, **kwargs): r""" 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): {a} {c} {f} - columns : str or 1d array + incols : str or 1d array Choose which columns are x, y, color, and size, respectively if - input is provided via *data*. E.g. ``columns = [0, 1]`` or - ``columns = '0,1'`` if the *x* values are stored in the first + input is provided via *data*. E.g. ``incols = [0, 1]`` or + ``incols = '0,1'`` if the *x* values are stored in the first column and *y* values in the second one. Note: zero-based indexing is used. label : str