Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-12-18 17:13:10 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/crates/bevy_transform
History
SpecificProtagonist d92fc1e456
Move required components doc to type doc (#16575) 
# Objective

Make documentation of a component's required components more visible by
moving it to the type's docs

## Solution

Change `#[require]` from a derive macro helper to an attribute macro.

Disadvantages:
- this silences any unused code warnings on the component, as it is used
by the macro!
- need to import `require` if not using the ecs prelude (I have not
included this in the migration guilde as Rust tooling already suggests
the fix)

---

## Showcase
![Documentation of
Camera](https://github.com/user-attachments/assets/3329511b-747a-4c8d-a43e-57f7c9c71a3c)

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: JMS55 <47158642+JMS55@users.noreply.github.com>
2024-12-03 19:45:20 +00:00
..
src Move required components doc to type doc (#16575) 2024-12-03 19:45:20 +00:00
Cargo.toml Remove thiserror from bevy_transform (#15761) 2024-10-09 14:27:30 +00:00
README.md Add README.md to all crates (#13184) 2024-05-02 18:56:00 +00:00

README.md

Bevy Transform

License Crates.io Downloads Docs Discord

This crate contains types and functions associated with the Transform component.