bevy/crates/bevy_ecs/macros/src
Joona Aalto 99b6f1d330
Link to required components docs in component type docs (#16687)
# Objective

#16575 moved required component docs from the `Component` impl to type
docs.

However, it doesn't actually link to what [required
components](https://docs.rs/bevy/0.15.0/bevy/ecs/component/trait.Component.html#required-components)
are and how they work.

## Solution

Link to [required
components](https://docs.rs/bevy/0.15.0/bevy/ecs/component/trait.Component.html#required-components)!

## Testing

I tested the link for some components in different Bevy crates. I did
not test in external third party crates, but I would assume that it
should work there too.

---

## Showcase

![Link to required
components](https://github.com/user-attachments/assets/888837dd-29a1-4092-be20-c7c6f0910174)

Note: The tooltip doesn't show the `#required-components` anchor for
some reason, but it is there.

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: SpecificProtagonist <vincentjunge@posteo.net>
2024-12-10 03:33:21 +00:00
..
component.rs Link to required components docs in component type docs (#16687) 2024-12-10 03:33:21 +00:00
lib.rs Move required components doc to type doc (#16575) 2024-12-03 19:45:20 +00:00
query_data.rs bevy_ecs: Replace panics in QueryData derive compile errors (#15691) 2024-10-07 16:30:34 +00:00
query_filter.rs Make QueryFilter an unsafe trait (#14790) 2024-09-09 15:23:12 +00:00
states.rs Computed State & Sub States (#11426) 2024-05-02 19:36:23 +00:00
world_query.rs Allow to expect (adopted) (#15301) 2024-09-20 19:16:42 +00:00