Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-26 06:30:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update docstrings for some Commands to use the correct type (#12111)

Browse source 
# Objective

- A tiny nit I noticed; I think the type of these function is
`EntityCommand`, not `Command`

Co-authored-by: Charles Bournhonesque <cbournhonesque@snapchat.com>
This commit is contained in:
Charles Bournhonesque 2024-02-25 14:48:33 -05:00 committed by GitHub
parent ff29c43916
commit 5bcc100d10
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
crates/bevy_ecs/src/system/commands/mod.rs
View file

@ -1086,7 +1086,7 @@ fn try_insert(bundle: impl Bundle) -> impl EntityCommand {
} }
} }
/// A [`Command`] that removes components from an entity. /// An [`EntityCommand`] that removes components from an entity.
/// For a [`Bundle`] type `T`, this will remove any components in the bundle. /// For a [`Bundle`] type `T`, this will remove any components in the bundle.
/// Any components in the bundle that aren't found on the entity will be ignored. /// Any components in the bundle that aren't found on the entity will be ignored.
fn remove<T: Bundle>(entity: Entity, world: &mut World) { fn remove<T: Bundle>(entity: Entity, world: &mut World) {
@ -1095,7 +1095,7 @@ fn remove<T: Bundle>(entity: Entity, world: &mut World) {
} }
} }
/// A [`Command`] that removes components from an entity. /// An [`EntityCommand`] that removes components from an entity.
/// For a [`Bundle`] type `T`, this will remove all components except those in the bundle. /// For a [`Bundle`] type `T`, this will remove all components except those in the bundle.
/// Any components in the bundle that aren't found on the entity will be ignored. /// Any components in the bundle that aren't found on the entity will be ignored.
fn retain<T: Bundle>(entity: Entity, world: &mut World) { fn retain<T: Bundle>(entity: Entity, world: &mut World) {