Skip to content

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Jul 29, 2025

Description of proposed changes

Add a Technical Reference page for the GMT justification codes for plot embellishments.

Fixes #4027

Preview
Technical Reference

Gallery examples and tutorials

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.

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 this to the 0.17.0 milestone Jul 29, 2025
@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Jul 29, 2025
@yvonnefroehlich yvonnefroehlich marked this pull request as draft July 29, 2025 18:24
@seisman
Copy link
Member

seisman commented Jul 30, 2025

Please note that justification codes are not only used when plotting embellishments, but also in Figure.text, Figure.meca, Figure.colorbar and more. So, we should have one page focusing on justification codes. We may extend the page and add a separata page for reference/anchor points later.

@yvonnefroehlich yvonnefroehlich changed the title DOC: Add Technical Reference page for justification codes (reference and anchor points) WIP: DOC: Add Technical Reference page for justification codes (reference and anchor points) Jul 30, 2025
@yvonnefroehlich
Copy link
Member Author

Please note that justification codes are not only used when plotting embellishments, but also in Figure.text, Figure.meca, Figure.colorbar and more. So, we should have one page focusing on justification codes. We may extend the page and add a separata page for reference/anchor points later.

Hm. I removed the contents related reference/anchor points. However, I am now a bit unsure what to add more to this Technical Reference page. Or do we only want the letters for vertical (TMB) and horizontal (LCR)?

@seisman
Copy link
Member

seisman commented Jul 30, 2025

What about adding figures like https://docs.generic-mapping-tools.org/dev/reference/features.html#reference-and-anchor-point-specification or https://docs.gmt-china.org/latest/basis/anchor/?

@yvonnefroehlich yvonnefroehlich changed the title WIP: DOC: Add Technical Reference page for justification codes (reference and anchor points) WIP: DOC: Add Technical Reference page for justification codes Aug 1, 2025
yvonnefroehlich and others added 5 commits September 2, 2025 15:10
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
@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. final review call This PR requires final review and approval from a second reviewer labels Sep 3, 2025
@seisman seisman merged commit a9630ce into main Sep 3, 2025
15 of 26 checks passed
@seisman seisman deleted the add-techref-justify branch September 3, 2025 09:27
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation about anchor code to the Technical Reference section
3 participants