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.

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

DOC: Add advanced tutorial "Creating legends" #3594

Open
wants to merge 59 commits into
base: main
Choose a base branch
from

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Nov 6, 2024

Description of proposed changes

This PR addes the advanced tutorial "Creating legends":

  • Create a auto-legend: label parameter of plotting methods
  • Adjust position: position parameter, +w, +o, +j
  • Add box: +p, +g
  • Create manuall legend: spec parameter, io.StringIO object

Fixes #3444

Preview: https://pygmt-dev--3594.org.readthedocs.build/en/3594/tutorials/advanced/legends.html

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation enhancement Improving an existing feature labels Nov 6, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Nov 6, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Nov 6, 2024
@yvonnefroehlich yvonnefroehlich marked this pull request as draft November 6, 2024 12:03
@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 16, 2024
49 tasks
@yvonnefroehlich yvonnefroehlich modified the milestones: 0.14.0, 0.15.0 Dec 27, 2024
@seisman seisman removed this from the 0.15.0 milestone Dec 31, 2024
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review February 9, 2025 16:36
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label 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.
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 am a bit unsure how detailed we want to explain the syntax of the legend specification here.

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

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 seisman added this to the 0.15.0 milestone Feb 12, 2025
@seisman seisman removed the enhancement Improving an existing feature label Feb 12, 2025
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

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

Looks good to me except one minor edit.

examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Feb 12, 2025
@seisman seisman changed the title WIP: DOC: Add advanced tutorial "Creating legends" DOC: Add advanced tutorial "Creating legends" Feb 12, 2025
Co-authored-by: Dongdong Tian <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation final review call This PR requires final review and approval from a second reviewer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a gallery example for Figure.legend with StringIO input
2 participants