Merge commit 'bwalton/bw/flexible_sent' into next

[sup] / lib / sup / update.rb

diff --git a/lib/sup/update.rb b/lib/sup/update.rb
index 9c28fdb0e948a5cd0bb398c290b733e641849e43..021b7e1b09eb93276bc03d659d36fb749f5c9aec 100644 (file)
--- a/lib/sup/update.rb
+++ b/lib/sup/update.rb
@@ -1,5 +1,16 @@
 module Redwood
 
+## Classic listener/broadcaster paradigm. Handles communication between various
+## parts of Sup.
+##
+## Usage note: don't pass threads around. Neither thread nor message equality is
+## defined anywhere in Sup beyond standard object equality. To communicate
+## something about a particular thread, just pass a representative message from
+## it around.
+##
+## (This assumes that no message will be a part of more than one thread within a
+## single "view". Luckily, that's true.)
+
 class UpdateManager
   include Singleton