fix docs

Author: databasedav

examples/basic.rs

@@ -1,4 +1,5 @@
-//!
+//! A simple increasing timer, without using the entity builder, showcasing the least invasive way
+//! to start using jonmo signals in existing Bevy apps.
 
 mod utils;
 use utils::*;
@@ -54,4 +55,3 @@ fn incr_value(mut ticker: ResMut<ValueTicker>, time: Res<Time>, mut values: Quer
 fn camera(mut commands: Commands) {
     commands.spawn(Camera2d);
 }
-

examples/basic_builder.rs

@@ -1,4 +1,4 @@
-//!
+//! A simple increasing timer, using the entity builder, showcasing the recommended, idiomatic way to use jonmo signals.
 mod utils;
 use utils::*;
 

examples/basic_builder_inject.rs

@@ -1,4 +1,5 @@
-//!
+//! A simple increasing timer, injecting the entity builder into an existing entity, showcasing a
+//! less invasive way to start using jonmo signals in existing Bevy apps.
 mod utils;
 use utils::*;
 

examples/filters.rs

@@ -207,7 +207,7 @@ fn text_node(text: &'static str) -> JonmoBuilder {
     ))
 }
 
-fn toggle<T: Eq + std::hash::Hash>(set: &mut HashSet<T>, value: T) {
+fn toggle<T: Eq + core::hash::Hash>(set: &mut HashSet<T>, value: T) {
     if !set.remove(&value) {
         set.insert(value);
     }

examples/letters.rs

@@ -1,8 +1,9 @@
-//!
+//! Diverse filtering options for a list of items, showcasing the power of vector signals.
 mod utils;
 use utils::*;
 
-use std::collections::BTreeMap;
+extern crate alloc;
+use alloc::collections::BTreeMap;
 
 use bevy_platform::collections::HashMap;
 

examples/test.rs

@@ -1,7 +1,6 @@
-//!
-
+#![allow(missing_docs)]
+#![allow(unused_variables)]
 mod utils;
-
 use utils::*;
 
 use bevy::prelude::*;

src/builder.rs

@@ -219,8 +219,8 @@ impl JonmoBuilder {
     } */
 
     /// Run a function that takes a [`Signal`] which outputs this builder's [`Entity`]'s
-    /// `generations`-nth generation ancestor and returns a [`Signal`]. Passing `0` to `generations`
-    /// will return this builder's [`Entity`] itself.
+    /// `generations`-th generation ancestor and returns a [`Signal`]. Passing `0` to `generations`
+    /// will output this builder's [`Entity`] itself.
     ///
     /// The resulting [`Signal`] will be automatically cleaned up when the [`Entity`] is despawned.
     pub fn signal_from_ancestor<S, F>(self, generations: usize, f: F) -> Self

src/signal.rs

@@ -615,18 +615,26 @@ impl SignalBuilder {
         Self::from_system(move |_: In<()>| entity.get())
     }
 
+    /// Creates a [`Source`] signal from an [`Entity`]'s `generations`-th generation ancestor's
+    /// [`Entity`]. Passing `0` to `generation` will output the [`Entity`] itself.
     pub fn from_ancestor(entity: Entity, generations: usize) -> Map<Source<Entity>, Entity> {
         Self::from_entity(entity).map(ancestor_map(generations))
     }
 
+    /// Creates a [`Source`] signal from a [`LazyEntity`]'s `generations`-th generation ancestor's
+    /// [`Entity`]. Passing `0` to `generation` will output the [`LazyEntity`]'s  [`Entity`] itself.
     pub fn from_ancestor_lazy(entity: LazyEntity, generations: usize) -> Map<Source<Entity>, Entity> {
         Self::from_lazy_entity(entity).map(ancestor_map(generations))
     }
 
+    /// Creates a [`Source`] signal from an [`Entity`]'s parent's [`Entity`]. Passing `0` to
+    /// `generation` will output the [`Entity`] itself.
     pub fn from_parent(entity: Entity) -> Map<Source<Entity>, Entity> {
         Self::from_ancestor(entity, 1)
     }
 
+    /// Creates a [`Source`] signal from a [`LazyEntity`]'s parent's [`Entity`]. Passing `0` to
+    /// `generation` will output the [`LazyEntity`]'s [`Entity`] itself.
     pub fn from_parent_lazy(entity: LazyEntity) -> Map<Source<Entity>, Entity> {
         Self::from_ancestor_lazy(entity, 1)
     }
@@ -1848,19 +1856,23 @@ impl<T: ?Sized> SignalExt for T where T: Signal {}
 
 #[cfg(test)]
 mod tests {
-    use super::*;
     use crate::{
         JonmoPlugin,
-        prelude::{MutableVec, SignalVecExt},
+        graph::{LazySignalHolder, SignalRegistrationCount},
+        prelude::{MutableVec, SignalVecExt, clone},
+        signal::{SignalBuilder, SignalExt, Upstream},
+        signal_vec::VecDiff,
+        utils::SSs,
     };
+    use core::{convert::identity, fmt};
 
     // Import Bevy prelude for MinimalPlugins and other common items
     use bevy::prelude::*;
     use bevy_platform::sync::*;
     use bevy_time::TimeUpdateStrategy;
 
     // Add Duration
-    use core::{convert::identity, time::Duration};
+    use core::time::Duration;
 
     // Helper component and resource for testing Add Default
     #[derive(Component, Clone, Debug, PartialEq, Reflect, Default)]
@@ -2624,7 +2636,7 @@ mod tests {
         // --- Test Some case ---
         let source_some = SignalBuilder::from_system(|_: In<()>| Some(42));
         let signal_some = source_some
-            .map_some(|In(val): In<i32>| format!("Got {}", val))
+            .map_some(|In(val): In<i32>| format!("Got {val}"))
             .map(capture_output)
             .register(app.world_mut());
         app.update();