From 8a6e2034b91e75bb34974787557327f136b41bfc Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Mon, 2 Aug 2021 20:26:12 -0400 Subject: [PATCH 1/4] Move label description to COMMON OPTIONS --- pygmt/helpers/decorators.py | 3 +++ pygmt/src/histogram.py | 3 +-- pygmt/src/plot.py | 4 +--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index 04df0ca4cfb..447df582a73 100644 --- a/pygmt/helpers/decorators.py +++ b/pygmt/helpers/decorators.py @@ -163,6 +163,9 @@ (:gmt-term:`PROJ_MEAN_RADIUS`), and the specification of latitude type (:gmt-term:`PROJ_AUX_LATITUDE`). Geodesic distance calculations is also controlled by method (:gmt-term:`PROJ_GEODESIC`).""", + "l": r""" + label : str + Add a legend entry for the symbol or line being plotted.""", "n": r""" interpolation : str [**b**\|\ **c**\|\ **l**\|\ **n**][**+a**][**+b**\ *BC*][**+c**][**+t**\ *threshold*]. diff --git a/pygmt/src/histogram.py b/pygmt/src/histogram.py index 80b6cb88efb..ece72986b21 100644 --- a/pygmt/src/histogram.py +++ b/pygmt/src/histogram.py @@ -119,8 +119,7 @@ def histogram(self, table, **kwargs): {XY} {U} {V} - label : str - Add a legend entry for the symbol or line being plotted. + {l} {p} {t} """ diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py index df87972074a..520df6773df 100644 --- a/pygmt/src/plot.py +++ b/pygmt/src/plot.py @@ -194,9 +194,7 @@ def plot(self, x=None, y=None, data=None, size=None, direction=None, **kwargs): {c} {f} {i} - label : str - Add a legend entry for the symbol or line being plotted. - + {l} {p} {t} *transparency* can also be a 1d array to set varying transparency From 3f20bf81e2a1b1f01e505ee7d626d70e09d5509d Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Mon, 2 Aug 2021 20:27:36 -0400 Subject: [PATCH 2/4] Move label description for plot3d --- pygmt/src/plot3d.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pygmt/src/plot3d.py b/pygmt/src/plot3d.py index 7a591c9c11f..d1e4a327647 100644 --- a/pygmt/src/plot3d.py +++ b/pygmt/src/plot3d.py @@ -164,8 +164,7 @@ def plot3d( {c} {f} {i} - label : str - Add a legend entry for the symbol or line being plotted. + {l} {p} {t} *transparency* can also be a 1d array to set varying transparency From bc553320ee8ac063257142bbb889815642e5312e Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Tue, 3 Aug 2021 19:12:42 -0400 Subject: [PATCH 3/4] Update pygmt/helpers/decorators.py Co-authored-by: Dongdong Tian --- pygmt/helpers/decorators.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index 447df582a73..c0ea78b3441 100644 --- a/pygmt/helpers/decorators.py +++ b/pygmt/helpers/decorators.py @@ -165,7 +165,7 @@ controlled by method (:gmt-term:`PROJ_GEODESIC`).""", "l": r""" label : str - Add a legend entry for the symbol or line being plotted.""", + Add a legend entry for the symbol or line being plotted.""", "n": r""" interpolation : str [**b**\|\ **c**\|\ **l**\|\ **n**][**+a**][**+b**\ *BC*][**+c**][**+t**\ *threshold*]. From 7ce206d68811d31d6a2b9b71cbd3ecd87aba7035 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Tue, 3 Aug 2021 20:19:02 -0400 Subject: [PATCH 4/4] Add link to full -l docs --- pygmt/helpers/decorators.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index c0ea78b3441..e8879eaa9b0 100644 --- a/pygmt/helpers/decorators.py +++ b/pygmt/helpers/decorators.py @@ -165,7 +165,8 @@ controlled by method (:gmt-term:`PROJ_GEODESIC`).""", "l": r""" label : str - Add a legend entry for the symbol or line being plotted.""", + Add a legend entry for the symbol or line being plotted. Full + documentation is at :gmt-docs:`gmt.html#l-full`.""", "n": r""" interpolation : str [**b**\|\ **c**\|\ **l**\|\ **n**][**+a**][**+b**\ *BC*][**+c**][**+t**\ *threshold*].