From 596b03dfd12428a73a527fe9b0b09333c68f3844 Mon Sep 17 00:00:00 2001
From: Jean-Paul Smets <jp@nexedi.com>
Date: Sat, 7 Nov 2009 10:25:04 +0000
Subject: [PATCH] Added comment to explain that explain should not return a
 list but a single message (divergence testers should not test multiple
 divergences at the same time if divergences can be resolved using different
 solvers).

git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@30388 20353a03-c40f-0410-a6d1-a30d3c3de9de
---
 product/ERP5/interfaces/divergence_tester.py | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/product/ERP5/interfaces/divergence_tester.py b/product/ERP5/interfaces/divergence_tester.py
index e654c4c260..50767c2127 100644
--- a/product/ERP5/interfaces/divergence_tester.py
+++ b/product/ERP5/interfaces/divergence_tester.py
@@ -67,7 +67,7 @@ class IDivergenceTester(Interface):
     
   def explain(simulation_movement):
     """
-    Returns a list of messages which explain the nature of
+    Returns a single message which explain the nature of
     the divergence of simulation_movement with its related
     delivery movement.
 
@@ -75,6 +75,11 @@ class IDivergenceTester(Interface):
     the recorded properties instead of the native ones.
 
     simulation_movement -- a simulation movement
+
+    NOTE: this approach is incompatible with previous
+    API which was returning a list.
+
+    NOTE: should we provide compatibility here ?
     """
 
   def generateHashKey(movement):
-- 
2.30.9