Link to required components docs in component type docs#16687
Merged
alice-i-cecile merged 2 commits intobevyengine:mainfrom Dec 10, 2024
Merged
Link to required components docs in component type docs#16687alice-i-cecile merged 2 commits intobevyengine:mainfrom
alice-i-cecile merged 2 commits intobevyengine:mainfrom
Conversation
Jondolf
added
C-Docs
MrGVSV
approved these changes
Dec 6, 2024
chescock
approved these changes
Dec 6, 2024
chescock
added
S-Ready-For-Final-Review
SpecificProtagonist
suggested changes
Dec 7, 2024
Contributor
There was a problem hiding this comment.
I did not test in external third party crates, but I would assume that it should work there too.
This works when using bevy_ecs directly, but not when depending on bevy:
A component’s [required components](bevy :: ecs::component::Component#required-components) are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.
Co-authored-by: SpecificProtagonist <[email protected]>
BD103
pushed a commit
to BD103/bevy
that referenced
this pull request
Dec 10, 2024
…6687) # Objective bevyengine#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  Note: The tooltip doesn't show the `#required-components` anchor for some reason, but it is there. --------- Co-authored-by: Alice Cecile <[email protected]> Co-authored-by: SpecificProtagonist <[email protected]>
ecoskey
pushed a commit
to ecoskey/bevy
that referenced
this pull request
Jan 6, 2025
…6687) # Objective bevyengine#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  Note: The tooltip doesn't show the `#required-components` anchor for some reason, but it is there. --------- Co-authored-by: Alice Cecile <[email protected]> Co-authored-by: SpecificProtagonist <[email protected]>
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
5 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
#16575 moved required component docs from the
Componentimpl to type docs.However, it doesn't actually link to what required components are and how they work.
Solution
Link to 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
Note: The tooltip doesn't show the
#required-componentsanchor for some reason, but it is there.