Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move description for -l common option to pygmt/helpers/decorators.py #1408

Merged
merged 6 commits into from
Aug 4, 2021
Merged

Move description for -l common option to pygmt/helpers/decorators.py #1408

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8a6e203
Move label description to COMMON OPTIONS
Aug 3, 2021
3f20bf8
Move label description for plot3d
Aug 3, 2021
bc55332
Update pygmt/helpers/decorators.py
Aug 3, 2021
d7c0c16
Merge branch 'master' into label-common
Aug 3, 2021
7ce206d
Add link to full -l docs
Aug 4, 2021
c4290d1
Merge branch 'master' into label-common
michaelgrund Aug 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions pygmt/helpers/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.""",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just checking, do we want to add the complicated -l stuff at https://github.com/GenericMappingTools/gmt/blob/6.2.0/doc/rst/source/explain_-l.rst_? And/or link to https://docs.generic-mapping-tools.org/6.2/gmt.html#l-full?

Suggested change
label : str
Add a legend entry for the symbol or line being plotted.""",
label : str
[*label*]\ [**+D**\ *pen*][**+G**\ *gap*][**+H**\ *header*][**+L**\ [*code*/]\ *txt*][**+N**\ *cols*][**+S**\ *size*\ [/*height*]][**+V**\ [*pen*]][**+f**\ *font*][**+g**\ *fill*][**+j**\ *just*][**+o**\ *off*][**+p**\ *pen*][**+s**\ *scale*][**+w**\ *width*]
Add a legend entry for the symbol or line being plotted.""",

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could add a link to the GMT docs. I chose not to add the complicated stuff because I thought the argument format could change in the near future with #1082.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, let's just add the link then. I also noticed that contour and grdcontour could benefit from a link to https://docs.generic-mapping-tools.org/6.2/gmt.html#l-full, but we can leave that for someone else to do in the ESWN workshop :)

"n": r"""
interpolation : str
[**b**\|\ **c**\|\ **l**\|\ **n**][**+a**][**+b**\ *BC*][**+c**][**+t**\ *threshold*].
Expand Down
3 changes: 1 addition & 2 deletions pygmt/src/histogram.py
View file
Open in desktop
Original file line number Diff 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
4 changes: 1 addition & 3 deletions pygmt/src/plot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions pygmt/src/plot3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down