Add an advanced tutorial for creating legends#3594
Merged
Conversation
seisman
reviewed
Nov 11, 2024
seisman
reviewed
Feb 4, 2025
yvonnefroehlich
commented
Feb 11, 2025
| # The following example is orientated on the related GMT example at | ||
| # :gmt-docs:`legend.html#examples`, but modified to use an :class:`io.StringIO` object. | ||
| # | ||
| # We start with setting up the :class:`io.StringIO` object. |
Member
Author
There was a problem hiding this comment.
I am a bit unsure how detailed we want to explain the syntax of the legend specification here.
Member
There was a problem hiding this comment.
I don't think we should explain the details here. We should refer users to read the GMT legend manual, or if we really want to explain it, it should be in the Technical Referecence, rather than in a tutorial.
Member
Author
There was a problem hiding this comment.
Agree, I also do not think it's good to have the details explained here; having this listed in the Technical Reference is a good point!
seisman
approved these changes
Feb 12, 2025
Member
seisman
left a comment
There was a problem hiding this comment.
Looks good to me except one minor edit.
Member
|
Will merge this PR after releasing v0.14.2. |
This file contains hidden or 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
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 addes the advanced tutorial "Creating legends":
labelparameter of plotting methodspositionparameter, +w, +o, +jspecparameter,io.StringIOobjectFixes #3444
Preview: https://pygmt-dev--3594.org.readthedocs.build/en/3594/tutorials/advanced/legends.html
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 command is:
/format: automatically format and lint the code