-
-
Couldn't load subscription status.
- Fork 4.2k
Improve the docs for ChildOf and Children #17886
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve the docs for ChildOf and Children #17886
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really great docs. As someone who hasn't messed with relationships that much, I think this is a brilliant introduction.
Co-authored-by: Eagster <[email protected]>
| use log::warn; | ||
|
|
||
| /// A [`Relationship`](crate::relationship::Relationship) component that creates the canonical | ||
| /// Stores the parent entity of this child entity with this component. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| /// Stores the parent entity of this child entity with this component. | |
| /// This component stores the parent entity of this child entity. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
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.