Skip to content

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Aug 10, 2025

Description of proposed changes

Add a Technical Reference page for reference and anchor points for plot embellishments.

Related to #4028, #4027

Previews:

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 Aug 10, 2025
@yvonnefroehlich yvonnefroehlich self-assigned this Aug 10, 2025
@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Aug 10, 2025
@yvonnefroehlich yvonnefroehlich marked this pull request as draft August 10, 2025 18:12
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review September 2, 2025 11:39
@yvonnefroehlich yvonnefroehlich marked this pull request as draft September 2, 2025 12:40

For placing plot embellishments, we distinguish between reference and anchor points. To set
these points users have to use the [justification codes](/techref/justification_codes.md).
The `offset` parameter allows to offset the anchor point from the reference point.
Copy link
Member

Choose a reason for hiding this comment

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

Please see changes in #4025. I think we should provide more details about the positioning of embellishments. The reference point is controlled by the position/position_type parameters, and the anchor point is defined by the anchor/anchor_offset parameters.

Copy link
Member Author

Choose a reason for hiding this comment

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

Totally agree @seisman! Will wait and leave this PR as draft until you have finished the work on this.

Copy link
Member

Choose a reason for hiding this comment

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

I think we should finish this PR first, so that we can reference this documentation in PRs like #4025.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah OK, that's also fine with me. Hope I will have time to work on this PR in the next days.

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.

2 participants