Skip to content

Commit 9fdffc0

Browse files
Meghan Jonesseismanmichaelgrund
authored
Move description for -l common option to pygmt/helpers/decorators.py (#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]>
1 parent b13cd4c commit 9fdffc0

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

pygmt/helpers/decorators.py

+4
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,10 @@
163163
(:gmt-term:`PROJ_MEAN_RADIUS`), and the specification of latitude type
164164
(:gmt-term:`PROJ_AUX_LATITUDE`). Geodesic distance calculations is also
165165
controlled by method (:gmt-term:`PROJ_GEODESIC`).""",
166+
"l": r"""
167+
label : str
168+
Add a legend entry for the symbol or line being plotted. Full
169+
documentation is at :gmt-docs:`gmt.html#l-full`.""",
166170
"n": r"""
167171
interpolation : str
168172
[**b**\|\ **c**\|\ **l**\|\ **n**][**+a**][**+b**\ *BC*][**+c**][**+t**\ *threshold*].

pygmt/src/histogram.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,7 @@ def histogram(self, table, **kwargs):
119119
{XY}
120120
{U}
121121
{V}
122-
label : str
123-
Add a legend entry for the symbol or line being plotted.
122+
{l}
124123
{p}
125124
{t}
126125
"""

pygmt/src/plot.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -194,9 +194,7 @@ def plot(self, x=None, y=None, data=None, size=None, direction=None, **kwargs):
194194
{c}
195195
{f}
196196
{i}
197-
label : str
198-
Add a legend entry for the symbol or line being plotted.
199-
197+
{l}
200198
{p}
201199
{t}
202200
*transparency* can also be a 1d array to set varying transparency

pygmt/src/plot3d.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,7 @@ def plot3d(
164164
{c}
165165
{f}
166166
{i}
167-
label : str
168-
Add a legend entry for the symbol or line being plotted.
167+
{l}
169168
{p}
170169
{t}
171170
*transparency* can also be a 1d array to set varying transparency

0 commit comments

Comments
 (0)