-
Notifications
You must be signed in to change notification settings - Fork 229
WIP: DOC: Add Technical Reference page for reference and anchor points #4052
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
base: main
Are you sure you want to change the base?
Conversation
|
||
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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Description of proposed changes
Add a Technical Reference page for reference and anchor points for plot embellishments.
Related to #4028, #4027
Previews:
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash command is:
/format
: automatically format and lint the code