[Erp5-report] r30632 - /erp5/trunk/products/ERP5/interfaces/business_buildable.py

[nobody at svn.erp5.org]

Author: jp
Date: Sun Nov 15 18:39:45 2009
New Revision: 30632

URL: http://svn.erp5.org?rev=30632&view=rev
Log:
Improved doc strings

Modified:
    erp5/trunk/products/ERP5/interfaces/business_buildable.py

Modified: erp5/trunk/products/ERP5/interfaces/business_buildable.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/interfaces/business_buildable.py?rev=30632&r1=30631&r2=30632&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/interfaces/business_buildable.py [utf8] (original)
+++ erp5/trunk/products/ERP5/interfaces/business_buildable.py [utf8] Sun Nov 15 18:39:45 2009
@@ -33,7 +33,13 @@
 from zope.interface import Interface
 
 class IBusinessBuildable(Interface):
-  """Business Buildable interface specification"""
+  """Business Buildable interface specification
+
+  This interface is implemented by Business Path as part
+  of Business Process management. It can be used to
+  check which path in a business process can be built
+  and to trigger the build process for a given path.
+  """
 
   def isBuildable(explanation):
     """Returns True if any of the related Simulation Movement
@@ -50,12 +56,13 @@
     'explanation' is the Order or Item or Document which is the
     cause of a root applied rule in the simulation
 
-    FIXME/JPS: Not sure if this will exist some day XXX
+    NOTE (JPS): It is not sure whether this method will ever
+    be used.
     """
 
   def build(explanation):
     """Builds all related movements in the simulation
-    using the builders of Business Path
+    using the builders defined on the Business Path
 
     'explanation' is the Order or Item or Document which is the
     cause of a root applied rule in the simulation