[LNT] r237657 - Some more comments in ComparisonResults

[Chris Matthews]

Author: cmatthews
Date: Mon May 18 20:59:16 2015
New Revision: 237657

URL: http://llvm.org/viewvc/llvm-project?rev=237657&view=rev
Log:
Some more comments in ComparisonResults

Modified:
    lnt/trunk/lnt/server/reporting/analysis.py

Modified: lnt/trunk/lnt/server/reporting/analysis.py
URL: http://llvm.org/viewvc/llvm-project/lnt/trunk/lnt/server/reporting/analysis.py?rev=237657&r1=237656&r2=237657&view=diff
==============================================================================
--- lnt/trunk/lnt/server/reporting/analysis.py (original)
+++ lnt/trunk/lnt/server/reporting/analysis.py Mon May 18 20:59:16 2015
@@ -27,8 +27,12 @@ def calc_geomean(run_values):
 
     return util.geometric_mean(values) - MIN_VALUE
 
+
 class ComparisonResult:
-    def __init__(self, cur_value, prev_value, delta, pct_delta, stddev, MAD,
+    """A ComparisonResult is ultimatly responsible for determining if a test
+    improves, regresses or does not change, given some new and old data."""
+    
+    def __init__(self,cur_value, prev_value, delta, pct_delta, stddev, MAD,
                  cur_failed, prev_failed, samples, prev_samples, stddev_mean = None,
                  confidence_lv = .05, bigger_is_better = False):
         self.current = cur_value