Move description for -l common option to pygmt/helpers/decorators.py #1408
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maxrjones
added
maintenance
maxrjones
added
the
final review call
seisman
reviewed
Aug 3, 2021
Co-authored-by: Dongdong Tian <[email protected]>
weiji14
reviewed
Aug 3, 2021
pygmt/helpers/decorators.py
Outdated
Comment on lines
167
to
168
| label : str | ||
| Add a legend entry for the symbol or line being plotted.""", |
There was a problem hiding this comment.
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.""", |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 :)
weiji14
approved these changes
Aug 4, 2021
weiji14
added
documentation
michaelgrund
approved these changes
Aug 4, 2021
seisman
removed
the
final review call
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
…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]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
This PR moves the description for the -l common option to pygmt/helpers/decorators.py for three methods that use the same description. Note that the alias used for PyGMT (label) is different than that for core GMT and GMT.jl (legend).
Fixes #
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version