Document composition order for Transform#23336
Merged
mockersf merged 1 commit intobevyengine:mainfrom Mar 15, 2026
Merged
Conversation
Contributor
|
Welcome, new contributor! Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨ |
kfc35
added
C-Docs
kfc35
approved these changes
Mar 12, 2026
tauanbinato
approved these changes
Mar 12, 2026
kfc35
added
S-Ready-For-Final-Review
mockersf
approved these changes
Mar 15, 2026
splo
pushed a commit
to splo/bevy
that referenced
this pull request
Mar 31, 2026
# Objective It is not obvious whether `t1 * t2` means that `t1` should be applied before or after `t2`. There may be a convention for matrix multiplication, but: 1. Not everyone may be familiar with it 2. It is not obvious that `Transform`s follow the same convention. ## Solution This specifies what the composition order is in the docs. ## Testing Nothing to test except checking that the documentation builds and displays correctly, which I did by running `cargo doc` and opening the result with a web browser. Co-authored-by: Grégoire Locqueville <git@glocq.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
It is not obvious whether
t1 * t2means thatt1should be applied before or aftert2. There may be a convention for matrix multiplication, but:Transforms follow the same convention.Solution
This specifies what the composition order is in the docs.
Testing
Nothing to test except checking that the documentation builds and displays correctly, which I did by running
cargo docand opening the result with a web browser.