Commit 596b03df authored by Jean-Paul Smets's avatar Jean-Paul Smets

Added comment to explain that explain should not return a list but a single...

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
parent 2ee9d6ae
...@@ -67,7 +67,7 @@ class IDivergenceTester(Interface): ...@@ -67,7 +67,7 @@ class IDivergenceTester(Interface):
def explain(simulation_movement): 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 the divergence of simulation_movement with its related
delivery movement. delivery movement.
...@@ -75,6 +75,11 @@ class IDivergenceTester(Interface): ...@@ -75,6 +75,11 @@ class IDivergenceTester(Interface):
the recorded properties instead of the native ones. the recorded properties instead of the native ones.
simulation_movement -- a simulation movement 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): def generateHashKey(movement):
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment