Move description for -l common option to pygmt/helpers/decorators.py (G…

…enericMappingTools#1408) * Move label description to COMMON OPTIONS * Add link to full -l docs Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Michael Grund <[email protected]>
sixy6e · Dec 21, 2022 · b5966aa · b5966aa
1 parent 79aeabc
commit b5966aa
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py
@@ -163,6 +163,10 @@
             (: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. Full
+            documentation is at :gmt-docs:`gmt.html#l-full`.""",
     "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
@@ -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
@@ -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

diff --git 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
-Original file line number
+Diff line change
@@ Expand Up / @@ -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}
         """
@@ Expand Down @@