Merge branch 'osc' of github.com:rcoh/SmootLight into osc

1 files changed, 20 insertions, 3 deletions

diff --git a/behaviors/BehaviorChain.py b/behaviors/BehaviorChain.py
index 39f4402..631ad98 100644
--- a/behaviors/BehaviorChain.py
+++ b/behaviors/BehaviorChain.py
@@ -3,6 +3,24 @@ import util.ComponentRegistry as compReg
 from logger import main_log
 import pdb
 class BehaviorChain(Behavior):
+    """BehaviorChain is a class which chains together multiple behavior.  BehaviorChain is in itself a
+    behavior, and behaves and can be used accordingly.  BehaviorChain also supports recursive hooks to
+    be set on its constituent behaviors.  ChainedBehaviors should be specified in <Args> as follows:
+
+    <ChainedBehaviors>
+        <Id>behavior1Id</Id>
+        <Id>behavior2Id</Id>
+    </ChainedBehaviors>
+
+    Behaviors may also be appended programmatically via the appendBehavior method.
+
+    Recursive hooks should be specified with Python dict syntax as follows:
+
+    <RecursiveHooks>{'behavior1Id':'hookid'}</RecursiveHooks>
+
+    Behavior Chain manages all recurrences that its constituents propogate.  At this point, it does not
+    support recurrences in its hooks."""
+
     def behaviorInit(self):
         self.feedback = {} #dictionary to allow feedback of recursives
         self.hooks = self['RecursiveHooks']
@@ -27,11 +45,10 @@ class BehaviorChain(Behavior):
                 hookBehavior.immediateProcessInput(recurrence, \
                         [])
                 if hookRecurrence != []:
-                    main_log.warn('Hook recurrences are not currently supported.  Implement it\
-yourself or bug russell')
+                    main_log.warn('Hook recurrences are not currently supported.') 
             self.feedback[behaviorId] = recurrence 
         return (response, [])
-
+    
     def appendBehavior(behavior):
         bid = compReg.registerComponent(behavior) #register behavior (will make
         #a new id if there isn't one)