Fix swapped docs for Rot2::rotation_to/from_y
#14307
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
mweatherley
added
C-Docs
alice-i-cecile
approved these changes
Jul 14, 2024
alice-i-cecile
added
S-Ready-For-Final-Review
MrGVSV
approved these changes
Jul 14, 2024
| @@ -229,7 +229,7 @@ impl Dir2 { | |||
| self.rotation_from_x().inverse() | |||
| } | |||
|
|
|||
| /// Get the rotation that rotates this direction to the Y-axis. | |||
| /// Get the rotation that rotates the Y-axis to this direction. | |||
There was a problem hiding this comment.
Question: would it be clearer and/or easier to remember if we used the term "from" in the docs?
Suggested change
| /// Get the rotation that rotates the Y-axis to this direction. | |
| /// Get the rotation that rotates to this direction from the Y-axis. |
There was a problem hiding this comment.
I tried this out, but I found that it makes the wording a little weird between the to/from method docs, so I think I'm going to leave it alone for now.
mockersf
pushed a commit
that referenced
this pull request
Aug 2, 2024
# Objective Fixes #14301 ## Solution Swap them so that they are no longer swapped.
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.
Objective
Fixes #14301
Solution
Swap them so that they are no longer swapped.