Explicitly state coordinate space in Aabb docs
- Dominant language
- Rust
- Stars
- 48.2k
- Forks
- 4.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 171
Description
In the docs for the Aabb component:
https://docs.rs/bevy/latest/bevy/render/primitives/struct.Aabb.html
it's not entirely clear what coordinate space inputs for the functions should be in.
Adding a line to clarify this such as:
> center and half_extents are stored in local space.
and updating function descriptions and comments, for example:
> `pub fn from_min_max(minimum: Vec3, maximum: Vec3) -> Aabb`
> min and max are in local space.
would help clear up the confusion.
Contributor guide
Research direction
Start from the Aabb API documentation at docs.rs and locate the descriptions for center, half_extents, and from_min_max. Clarify that the values use local space, including the function descriptions and comments; done when the coordinate space is explicit throughout the Aabb documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100