svn commit: r1514828 - /incubator/climate/branches/RefactorInput/ocw/evaluation.py

[jo...@apache.org]

Author: joyce
Date: Fri Aug 16 18:07:06 2013
New Revision: 1514828

URL: http://svn.apache.org/r1514828
Log:
CLIMATE-258 - Improve Evaluation.run's docstring

Modified:
    incubator/climate/branches/RefactorInput/ocw/evaluation.py

Modified: incubator/climate/branches/RefactorInput/ocw/evaluation.py
URL: http://svn.apache.org/viewvc/incubator/climate/branches/RefactorInput/ocw/evaluation.py?rev=1514828&r1=1514827&r2=1514828&view=diff
==============================================================================
--- incubator/climate/branches/RefactorInput/ocw/evaluation.py (original)
+++ incubator/climate/branches/RefactorInput/ocw/evaluation.py Fri Aug 16 18:07:06 2013
@@ -202,7 +202,21 @@ class Evaluation(object):
 
 
     def run(self):
-        '''Run the evaluation.'''
+        '''Run the evaluation.
+
+        There are two phases to a run of the Evaluation. First, if there are
+        any "binary" metrics they are run through the evaluation. Binary
+        metrics are only run if there is a reference dataset and at least one
+        target dataset.
+
+        If there is subregion information provided then each dataset is subset
+        before being run through the binary metrics. 
+        
+        ..note:: Only the binary metrics are subset with subregion information.
+
+        Next, if there are any "unary" metrics they are run. Unary metrics are
+        only run if there is at least one target dataset or a reference dataset.
+        '''
         if not self._evaluation_is_valid():
             error = "The evaluation is invalid. Check the docs for help."
             logging.warning(error)