doc(iter): add doc for fns world and real_world

Indra-db · Jan 10, 2025 · 2c72543 · 2c72543
1 parent 8633e4b
commit 2c72543
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/flecs_ecs/src/core/table/iter.rs b/flecs_ecs/src/core/table/iter.rs
@@ -14,10 +14,12 @@ impl<'a, const IS_RUN: bool, P> TableIter<'a, IS_RUN, P>
 where
     P: ComponentId,
 {
+    /// The world. Can point to stage when in deferred/readonly mode.
     pub fn world(&self) -> WorldRef<'a> {
         unsafe { WorldRef::from_ptr(self.iter.world) }
     }
 
+    /// Actual world. Never points to a stage.
     pub fn real_world(&self) -> WorldRef<'a> {
         unsafe { WorldRef::from_ptr(self.iter.real_world) }
     }