bevyengine / bevyengine/bevy

Better explain what does `Transform::mul_transform` does

Open
#6,178 1 comment 0 reactions 0 assignees View on GitHub
A-Transform C-Docs D-Straightforward S-Ready-For-Implementation
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 22h
Merged PRs (30d)
161

Description

## How can Bevy's documentation be improved?

Currently [`Transform::mul_transform`](https://docs.rs/bevy/latest/bevy/prelude/struct.Transform.html#method.mul_transform) has documentation "Multiplies self with transform component by component, returning the resulting [Transform](https://docs.rs/bevy/latest/bevy/transform/components/struct.Transform.html)". This is misleading:

- You need to check what components are and what they do
- It's not actual implementation as multiplication of translation vectors doesn't make sense

If the code was on [`Mat4`](https://docs.rs/bevy/latest/bevy/math/f32/struct.Mat4.html) it could depend on preexisting knowledge of how matrices work in 3D graphics. However absent of it, it should be something more like: "Multiplication creates a new transformation which first applies `transform` transformation and than `self`. Resulting transformation is returned". It might be nice to rename it to something like `combine` and `mul_vec` to apply if bevy tries to be friendly and avoid exposing user to transformation matrices.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.