-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
[Merged by Bors] - bevy::scene::Entity renamed to bevy::scene::DynamicEntity. #3448
Conversation
…mentation added to bevy::scene::DynamicEntity and bevy::scene::DynamicScene.
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.
Wow, those are excellent docs for a new contributor! Thanks for tackling this.
I think I would cut the # Arguments
section from these docs; we don't use that style elsewhere and by-and-large the arguments here are self-evident.
Alright, I'll remove them. |
/// Write the dynamic entities and their corresponding components to the given world. | ||
/// | ||
/// This method will return an `SceneSpawnError` if either the type of a | ||
/// component or the component itself hasn't been registered. |
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.
To be more precise, the two errors cases are when a type is not registered and when a type doesn't reflect the Component trait.
bors r+ |
Basic documentation added to bevy::scene::DynamicEntity and bevy::scene::DynamicScene. # Objective - Rename bevy::scene::Entity to bevy::scene::DynamicEntity - fixes #3233 ## Solution - Renamed the struct as requested. - Added basic documentation. Co-authored-by: r4gus <[email protected]>
Pull request successfully merged into main. Build succeeded: |
Basic documentation added to bevy::scene::DynamicEntity and bevy::scene::DynamicScene.
Objective
Solution