Add docs to ah::ObjectLabel #4534
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nilsvu
added
documentation
small
knelli2
requested changes
Dec 19, 2022
src/ApparentHorizons/ObjectLabel.hpp
Outdated
Comment on lines
12
to
14
| /// The object on the right side (along the grid-frame x-axis) | ||
| A, | ||
| /// The object on the left side (along the grid-frame x-axis) |
There was a problem hiding this comment.
Maybe don't say right and left here because that's subjective to viewing angle. I know our convention is negative x on the left, but only saying positive/negative x-axis is unambiguous. How about just
The object along the positive/negative x-axis in the grid frame
?
knelli2
approved these changes
Dec 21, 2022
markscheel
approved these changes
Jan 12, 2023
nilsdeppe
approved these changes
Jan 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Define that A should always be to the right of B in the grid frame. This is the SpEC convention. We make this assumption in the control systems (see also #4532). Discussion about potentially renaming A/B is in #4529.
Upgrade instructions
Code review checklist
make docto generate the documentation locally intoBUILD_DIR/docs/html.Then open
index.html.code review guide.
bugfixornew featureif appropriate.Further comments