[Erp5-report] r27531 - /erp5/trunk/products/ERP5/Document/TradeCondition.py

[nobody at svn.erp5.org]

Author: fabien
Date: Thu Jun 11 16:23:54 2009
New Revision: 27531

URL: http://svn.erp5.org?rev=27531&view=rev
Log:
improve a bit docstring

Modified:
    erp5/trunk/products/ERP5/Document/TradeCondition.py

Modified: erp5/trunk/products/ERP5/Document/TradeCondition.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/Document/TradeCondition.py?rev=27531&r1=27530&r2=27531&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/Document/TradeCondition.py [utf8] (original)
+++ erp5/trunk/products/ERP5/Document/TradeCondition.py [utf8] Thu Jun 11 16:23:54 2009
@@ -241,7 +241,7 @@
     def getCell(self, *kw , **kwd):
       '''
       Overload the function getCell to be able to search a cell on the
-      inheritance model tree
+      inheritance model tree if the cell is not found on current one.
       '''
       cell = XMLMatrix.getCell(self, *kw, **kwd)
       # if cell not found, look on the inherited models
@@ -263,10 +263,9 @@
     security.declareProtected(Permissions.AccessContentsInformation,
         'getReferenceDict')
     def getReferenceDict(self, portal_type_list, property_list=None):
-      '''Return all objects reference and id of the model wich portal_type is in
-      the portal_type_list. If type does not have a reference, it's ID is used.
-      If property_list is provided, only objects for which at least one of
-      properties is true will be added.
+      '''Return a dict containing all id's of the objects contained in
+      this model and correponding to the given portal_type. The key of the dict
+      are the reference (or id if no reference)
       '''
       if property_list is None:
         property_list=[]
@@ -286,7 +285,10 @@
     security.declareProtected(Permissions.AccessContentsInformation,
         'findEffectiveSpecialiseValueList')
     def findEffectiveSpecialiseValueList(self, start_date=None, stop_date=None):
-      '''Return a list of effective models
+      '''Returns a list of effective specialised objects representing 
+      inheritance tree.
+      An effective object is an object wich start and stop_date are equal (or
+      included) to the range of the given start and stop_date.
       '''
       model_list = self.findSpecialiseValueList(self)
       if start_date is None and stop_date is None:
@@ -300,10 +302,10 @@
     def getInheritanceReferenceDict(self, portal_type_list,
         property_list=None):
       '''Returns a dict with the model url as key and a list of reference as
-      value. Normaly, a Reference appear only one time in the final output.
+      value. A Reference can appear only one time in the final output.
       It uses Breadth First Search.
-      If property_list is not empty, documents for which all properties in
-      property_list are false will be skipped.
+      If property_list is not empty, documents which don't have any of theses
+      properties will be skipped.
       '''
       if property_list is None:
         property_list=[]
@@ -318,7 +320,7 @@
           if reference not in reference_list:
             reference_list.append(reference)
             id_list.append(model_reference_list[reference])
-        if id_list != []:
+        if len(id_list) != 0:
           model_reference_dict[model.getRelativeUrl()]=id_list
       return model_reference_dict
 
@@ -327,6 +329,9 @@
     def getEffectiveModel(self, start_date=None, stop_date=None):
       '''return the more appropriate model using effective_date, expiration_date
       and version number
+      An effective model is a model wich start and stop_date are equal (or
+      included) to the range of the given start and stop_date and with the
+      higher version number (if there is more than one)
       '''
       reference = self.getReference()
       if not reference: