Skip to content

WIP: DOC: Add Technical Reference page for justification codes #4028

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

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

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:

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
@seisman
Copy link
Member

seisman commented Aug 7, 2025

Maybe we should focus on justification codes in this PR and add content for reference and anchor points in a separate PR?

@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Aug 9, 2025

Maybe we should focus on justification codes in this PR and add content for reference and anchor points in a separate PR?

Yes, this makes review easier, and I am fine with having two separate PRs. I would like to keep both scripts in this PR to ensure consistent sketches for both the justification codes and the reference and anchor points. If we have the final version, I will move the reference and anchor points and related content to a separate PR before merging this PR.

@yvonnefroehlich
Copy link
Member Author

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/?

I have re-created these sketches in PyGMT. @GenericMappingTools/pygmt-maintainers Can people please report if they are happy with the visualizations? I prefer to have the sketches for justify codes and reference and anchor points consistent 🙂 before splitting this PR into two sseparate PRs.

@seisman
Copy link
Member

seisman commented Aug 10, 2025

They look good.

@yvonnefroehlich yvonnefroehlich self-assigned this Aug 13, 2025
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review August 13, 2025 19:14
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