Doc collector

Author: FilippoOlivo

pina/collector.py

@@ -8,13 +8,15 @@
 
 class Collector:
     """
-    Collector class for collecting data from the problem.
+    Collector class for retrieving data from different conditions in the 
+    problem.
     """
 
     def __init__(self, problem):
-        """ "
+        """
         Initialize the Collector class, by creating a hook between the collector
-        and the problem and initializing the data collections.
+        and the problem and initializing the data collections (dictionary where 
+        data will be stored).
 
         :param AbstractProblem problem: The problem to collect data from.
         """
@@ -34,15 +36,18 @@ def __init__(self, problem):
     @property
     def full(self):
         """
-        Return True if all conditions are ready.
+        Whether all conditions are ready or not.
+
+        :return: True if all conditions are ready.
+        :rtype: bool
         """
 
         return all(self._is_conditions_ready.values())
 
     @full.setter
     def full(self, value):
         """
-        Set the full property of the collector. Admit only boolean values.
+        Check the consistency of the value and set the full property.
 
         :param bool value: The value to set the full property to.
         """
@@ -52,10 +57,9 @@ def full(self, value):
     @property
     def data_collections(self):
         """
-        Return the data collections, created by combining together all condition
-        in the problem.
+        Return the data collections.
 
-        :return: The data collections.
+        :return: The data collections where the data is stored.
         :rtype: dict
         """
 
@@ -64,20 +68,19 @@ def data_collections(self):
     @property
     def problem(self):
         """
-        Property that return the problem connected to the collector.
+        Problem connected to the collector.
 
-        :return: The problem connected to the collector.
+        :return: The problem from which the data is collected.
         :rtype: AbstractProblem
         """
         return self._problem
 
     @problem.setter
     def problem(self, value):
         """
-        Return the problem connected to the collector.
+        Ser the problem connected to the collector.
 
-        return: The problem connected to the collector.
-        rtype: AbstractProblem
+        :param AbstractProblem value: The problem to connect to the collector.
         """
 
         self._problem = value
@@ -111,6 +114,7 @@ def store_sample_domains(self):
         Store inside data collections the sampled data of the problem. These
         comes from the conditions that require sampling.
         """
+        
         for condition_name in self.problem.conditions:
             condition = self.problem.conditions[condition_name]
             if not hasattr(condition, "domain"):