improve the doc string of compare().

git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@31124 20353a03-c40f-0410-a6d1-a30d3c3de9de

product/ERP5/interfaces/divergence_tester.py

@@ -98,7 +98,7 @@ class IDivergenceTester(Interface):
 
   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 @@ class IDivergenceTester(Interface):
     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):

product/ERP5/mixin/divergence_tester.py

@@ -103,7 +103,7 @@ class DivergenceTesterMixin:
 
   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 @@ class DivergenceTesterMixin:
     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)