diff --git a/product/ERP5/interfaces/divergence_tester.py b/product/ERP5/interfaces/divergence_tester.py index e654c4c2605c3add12138a4e2569bf202ac91c0a..50767c212715d61cbd6cee30aa8bb5e5d42db68f 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):