[Erp5-report] r31124 kazuhiko - in /erp5/trunk/products/ERP5: interfaces/ mixin/

[nobody at svn.erp5.org]

Author: kazuhiko
Date: Mon Dec  7 15:28:41 2009
New Revision: 31124

URL: http://svn.erp5.org?rev=31124&view=rev
Log:
improve the doc string of compare().

Modified:
    erp5/trunk/products/ERP5/interfaces/divergence_tester.py
    erp5/trunk/products/ERP5/mixin/divergence_tester.py

Modified: erp5/trunk/products/ERP5/interfaces/divergence_tester.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/interfaces/divergence_tester.py?rev=31124&r1=31123&r2=31124&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/interfaces/divergence_tester.py [utf8] (original)
+++ erp5/trunk/products/ERP5/interfaces/divergence_tester.py [utf8] Mon Dec  7 15:28:41 2009
@@ -98,7 +98,7 @@
 
   def compare(prevision_movement, decision_movement):
     """
-    Returns True if simulation_movement and delivery_movement
+    Returns True if prevision_movement and delivery_movement
     match. Returns False else. The method is asymmetric and
     the order of parameter matters. For example, a sourcing
     rule may use a tester which makes sure that movements are
@@ -108,9 +108,10 @@
     If decision_movement is a simulation movement, use
     the recorded properties instead of the native ones.
 
-    prevision_movement -- a simulation movement (prevision)
-
-    decision_movement -- a delivery movement (decision)
+    This method is used in three cases:
+    * an applied rule containted movement vs. a generated movement list
+    * a delivery containted movement vs. a generated movement list
+    * a delivery containted movement vs. an applied rule containted movement
     """
 
   def getUpdatablePropertyDict(prevision_movement, decision_movement):

Modified: erp5/trunk/products/ERP5/mixin/divergence_tester.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/mixin/divergence_tester.py?rev=31124&r1=31123&r2=31124&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/mixin/divergence_tester.py [utf8] (original)
+++ erp5/trunk/products/ERP5/mixin/divergence_tester.py [utf8] Mon Dec  7 15:28:41 2009
@@ -103,7 +103,7 @@
 
   def compare(self, prevision_movement, decision_movement):
     """
-    Returns True if simulation_movement and delivery_movement
+    Returns True if prevision_movement and delivery_movement
     match. Returns False else. The method is asymmetric and
     the order of parameter matters. For example, a sourcing
     rule may use a tester which makes sure that movements are
@@ -113,9 +113,10 @@
     If decision_movement is a simulation movement, use
     the recorded properties instead of the native ones.
 
-    prevision_movement -- a simulation movement (prevision)
-
-    decision_movement -- a delivery movement (decision)
+    This method is used in three cases:
+    * an applied rule containted movement vs. a generated movement list
+    * a delivery containted movement vs. a generated movement list
+    * a delivery containted movement vs. an applied rule containted movement
     """
     return (self._compare(prevision_movement, decision_movement) is None)