Skip to content

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.

Sign up for GitHub

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

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

DOC: Add Technical Reference page for justification codes #4028

wants to merge 59 commits into from

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Jul 29, 2025 •
edited
Loading

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.

michaelgrund
michaelgrund reviewed Jul 30, 2025
View reviewed changes
@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 yvonnefroehlich self-assigned this Aug 13, 2025
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review August 13, 2025 19:14
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Aug 19, 2025
@yvonnefroehlich yvonnefroehlich changed the title WIP: DOC: Add Technical Reference page for justification codes DOC: Add Technical Reference page for justification codes Aug 19, 2025
seisman
seisman reviewed Aug 20, 2025
View reviewed changes
seisman
seisman reviewed Aug 21, 2025
View reviewed changes
doc/techref/justification_codes.md Outdated

# Justification codes

To adjust the position of plot embellishments, such as scalebars, directional roses,
Copy link
Member

Choose a reason for hiding this comment

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

I feel the description could be better and more accurage, but I don't have good suggestions yet.

yvonnefroehlich
yvonnefroehlich commented Aug 22, 2025
View reviewed changes
doc/techref/justification_codes.md
# Justification codes

To place plot embellishments, such as scalebars, directional roses, colorbars,
legends, text, and images on a figure two points have to be specified: a point
Copy link
Member Author

Choose a reason for hiding this comment

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

Here, we could link to the reference pages for reference and anchor points which will be added in PR #4052 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@seisman seisman seisman left review comments

@michaelgrund michaelgrund michaelgrund left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@yvonnefroehlich yvonnefroehlich

Labels
documentation Improvements or additions to documentation needs review This PR has higher priority and needs review.
Projects
None yet
Milestone
0.17.0
Development

Successfully merging this pull request may close these issues.

Add documentation about anchor code to the Technical Reference section
3 participants
@yvonnefroehlich @seisman @michaelgrund