Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Merged by Bors] - bevy::scene::Entity renamed to bevy::scene::DynamicEntity. #3448

Closed
wants to merge 3 commits into from
Closed

[Merged by Bors] - bevy::scene::Entity renamed to bevy::scene::DynamicEntity. #3448

wants to merge 3 commits into from

Conversation

r4gus
Copy link
Contributor

@r4gus r4gus commented Dec 27, 2021 •
edited
Loading

Basic documentation added to bevy::scene::DynamicEntity and bevy::scene::DynamicScene.

Objective

Solution

  • Renamed the struct as requested.
  • Added basic documentation.

@r4gus
bevy::scene::Entity renamed to bevy::scene::DynamicEntity. Basic docu…
5b8934b 
…mentation added to bevy::scene::DynamicEntity and bevy::scene::DynamicScene.
@github-actions github-actions bot added the S-Needs-Triage This issue needs to be labelled label Dec 27, 2021
@alice-i-cecile alice-i-cecile added A-Scenes Serialized ECS data stored on the disk C-Code-Quality A section of code that is hard to understand or change C-Docs An addition or correction to our documentation and removed S-Needs-Triage This issue needs to be labelled labels Dec 27, 2021
alice-i-cecile
alice-i-cecile approved these changes Dec 27, 2021
View reviewed changes
Copy link
Member

@alice-i-cecile alice-i-cecile left a 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.

@r4gus
Copy link
Contributor Author

r4gus commented Dec 27, 2021

Alright, I'll remove them.

Davier
Davier reviewed Dec 27, 2021
View reviewed changes
crates/bevy_scene/src/dynamic_scene.rs Outdated
/// 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.
Copy link
Contributor

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.

@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Dec 27, 2021
@cart
Copy link
Member

cart commented Dec 27, 2021

bors r+

bors bot pushed a commit that referenced this pull request Dec 27, 2021
@r4gus
bevy::scene::Entity renamed to bevy::scene::DynamicEntity. (#3448)
3a9d5a6 
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]>
@bors
Copy link
Contributor

bors bot commented Dec 27, 2021

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title bevy::scene::Entity renamed to bevy::scene::DynamicEntity. [Merged by Bors] - bevy::scene::Entity renamed to bevy::scene::DynamicEntity. Dec 27, 2021
@bors bors bot closed this Dec 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

@Davier Davier Davier approved these changes

Assignees
No one assigned
Labels
A-Scenes Serialized ECS data stored on the disk C-Code-Quality A section of code that is hard to understand or change C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document and rename bevy::scene::Entity
4 participants
@r4gus @cart @Davier @alice-i-cecile