Clarify docs for operators performing xform_inv
#83461
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
aaronfranke
approved these changes
Oct 16, 2023
There was a problem hiding this comment.
Looks good from a quick review, it's really good to clarify this, I often forget if scaling is allowed or not, and explaining how the operator works is likewise very helpful.
In the future, if is_orthonormal is exposed, we could update these docs to link to that.
|
Thanks! |
I'll do so in subsequent PR I guess. 🙃 |
|
Welp :D You can mark the PR as draft to prevent merging if some changes are still pending. |
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.
Clarifies docs for the
operator*s performingxform_inv. Most of these were said to "inversly transform ..." but in most cases that's not always true. I've checked the source for these one by one, hopefully got everything right. Also changed some other relevant docs. Correcting mistakes/inconsistencies, suggestions on wording, etc. welcomed as always. 🙂C# version: #83514.