Document EntityMut::remove() (#6168)

# Objective - Fixes #5990 ## Solution - Add docs for `EntityMut::remove()` explaining its return value.
bevyengine · Oct 5, 2022 · 2a6b544 · 2a6b544
1 parent 29098b7
commit 2a6b544
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;