docs(cache): Added important notes on memory management for Memo and Signal types, emphasizing the use of Weak types when referencing between structures to avoid memory leaks and circular references.

Author: fxdmhtt

cache/src/memo.rs

@@ -18,6 +18,14 @@ use crate::{IObservable, memo_stack, store_in_cache, touch};
 /// # Type Parameters
 ///
 /// - `T`: The result type of the computation. Must implement `Clone`.
+/// 
+/// # Memory Management Note
+///
+/// When referencing `Memo` instances that belong to other struct instances
+/// (for example, when one `ViewModel` holds references to memos in another `ViewModel`),
+/// you **must** store them as `Weak<Memo<T>>` obtained via `Rc::downgrade` instead of
+/// cloning a strong `Rc`. Failing to do so can create reference cycles between the structs
+/// and their dependent effects, preventing proper cleanup and causing memory leaks.
 ///
 /// # Examples
 ///

cache/src/signal.rs

@@ -21,6 +21,14 @@ use crate::{Effect, IMemo, IObservable, effect_stack::EffectStackEntry};
 ///
 /// - `T`: The type of the value stored in the signal. Must implement `Eq`.
 ///
+/// # Memory Management Note
+///
+/// When referencing `Signal` instances that belong to other struct instances
+/// (for example, when one `ViewModel` holds references to signals in another `ViewModel`),
+/// you **must** store them as `Weak<Signal<T>>` obtained via `Rc::downgrade` instead of
+/// cloning a strong `Rc`. Failing to do so can create reference cycles between the structs
+/// and their dependent effects, preventing proper cleanup and causing memory leaks.
+///
 /// # Examples
 ///
 /// ## Basic usage
@@ -60,8 +68,15 @@ use crate::{Effect, IMemo, IObservable, effect_stack::EffectStackEntry};
 /// assert_eq!(*vm.name.get(), "Bob");
 /// ```
 pub struct Signal<T> {
+    /// Current value of the signal.
     value: RefCell<T>,
+
+    /// Memoized computations that depend on this signal.
+    /// Weak references are used to avoid memory leaks.
     dependents: RefCell<Vec<Weak<dyn IMemo>>>,
+
+    /// Effects that depend on this signal.
+    /// Weak references prevent retaining dropped effects.
     effects: RefCell<Vec<Weak<Effect>>>,
 }