Document EntityMut::remove()

xgbwei · Oct 4, 2022 · b1087ab · b1087ab
1 parent 8a26812
commit b1087ab
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/bevy_ecs/src/world/entity_ref.rs b/crates/bevy_ecs/src/world/entity_ref.rs
@@ -277,6 +277,9 @@ impl<'w> EntityMut<'w> {
     }
 
     // TODO: move to BundleInfo
+    /// Removes a [`Bundle`] of components from the entity and returns the bundle.
+    ///
+    /// Returns `None` if the entity does not contain the bundle.
     pub fn remove<T: Bundle>(&mut self) -> Option<T> {
         let archetypes = &mut self.world.archetypes;
         let storages = &mut self.world.storages;