From f5d257ff2670147ec4ddc77862a8c93c02e21deb Mon Sep 17 00:00:00 2001 From: HampusM Date: Tue, 22 Apr 2025 18:47:53 +0200 Subject: docs(ecs): correct doc comments of World functions --- ecs/src/lib.rs | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/ecs/src/lib.rs b/ecs/src/lib.rs index c953290..53abc6b 100644 --- a/ecs/src/lib.rs +++ b/ecs/src/lib.rs @@ -94,9 +94,6 @@ impl World } /// Creates a new entity with the given components. - /// - /// # Panics - /// Will panic if mutable internal lock cannot be acquired. pub fn create_entity(&mut self, components: Comps) -> Uid where Comps: ComponentSequence, @@ -168,9 +165,6 @@ impl World } /// Adds a extensions. - /// - /// # Panics - /// Will panic if mutable internal lock cannot be acquired. pub fn add_extension(&mut self, extension: impl Extension) { let extension_collector = ExtensionCollector::new(self); @@ -195,9 +189,8 @@ impl World } /// Performs a single tick. - /// /// # Panics - /// Will panic if a internal lock cannot be acquired. + /// Will panic if mutable internal lock cannot be acquired. pub fn step(&mut self) -> StepResult { if self.stop.load(Ordering::Relaxed) { @@ -240,9 +233,6 @@ impl World } /// Starts a loop which calls [`Self::step`] until the world is stopped. - /// - /// # Panics - /// Will panic if a internal lock cannot be acquired. pub fn start_loop(&mut self) { while let StepResult::Continue = self.step() {} -- cgit v1.2.3-18-g5258