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

WIP: DOC: Add advanced tutorial "Creating legends" #3594

Draft
wants to merge 42 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
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
@yvonnefroehlich yvonnefroehlich changed the title POC: WIP: DOC: Add advanced tutorial "Legend" WIP: DOC: Add advanced tutorial "Legends" Nov 11, 2024
@yvonnefroehlich yvonnefroehlich changed the title WIP: DOC: Add advanced tutorial "Legends" WIP: DOC: Add advanced tutorial "Creating legends" Nov 11, 2024
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Show resolved Hide resolved
examples/tutorials/advanced/legends.py Outdated Show resolved Hide resolved
examples/tutorials/advanced/legends.py Show resolved Hide resolved
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 enhancement Improving an existing feature
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