Improve the docs for ChildOf and Children#17886
Merged
alice-i-cecile merged 4 commits intobevyengine:mainfrom Feb 17, 2025
Merged
Improve the docs for ChildOf and Children#17886alice-i-cecile merged 4 commits intobevyengine:mainfrom
alice-i-cecile merged 4 commits intobevyengine:mainfrom
Conversation
AlephCubed
approved these changes
Feb 16, 2025
ElliottjPierce
approved these changes
Feb 17, 2025
Contributor
ElliottjPierce
left a comment
There was a problem hiding this comment.
Really great docs. As someone who hasn't messed with relationships that much, I think this is a brilliant introduction.
Co-authored-by: Eagster <79881080+ElliottjPierce@users.noreply.github.com>
Carter0
reviewed
Feb 17, 2025
| use log::warn; | ||
|
|
||
| /// A [`Relationship`](crate::relationship::Relationship) component that creates the canonical | ||
| /// Stores the parent entity of this child entity with this component. |
Contributor
There was a problem hiding this comment.
Suggested change
| /// Stores the parent entity of this child entity with this component. | |
| /// This component stores the parent entity of this child entity. |
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
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.
Context
Renaming
ParenttoChildOfin #17247 has been contentious. While those users concerns are valid (especially around legibility of code IMO!), @cart has decided to stick with the new name.Objective
The new documentation doesn't do a particularly good job at quickly explaining the meaning of each component or how to work with them; making a tricky migration more painful and slowing down new users as they learn about some of the most fundamental types in Bevy.
Solution
IsParent/IsChild/Parentnames, to improve autocomplete and doc searching.