[Predator] renamed "Result" to "Suspect"

appengine/findit/crash/culprit.py

 # Copyright 2016 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 from collections import namedtuple
 
 
 class Culprit(namedtuple('Culprit',
     ['project', 'components', 'cls', 'regression_range', 'algorithm'])):
   """The result of successfully identifying the culprit of a crash report.
 
+  That is, this is what ``Predator.FindCultprit`` returns. It encapsulates
+  all the information predator discovered during its various analyses.
+
   Args:
     project (str): the most-suspected project
     components (list of str): the suspected crbug components.
     cls (list of ??): the suspected CLs.
     regression_range (tuple): a pair of the last-good and first-bad versions.
     algorithm (str): What algorithm was used to produce this object.
   """
   __slots__ = ()
 
   @property
@@ skipping 60 matching lines @@
         }
         For results using git blame without a regression range: {
             'found_suspects': True,
             'has_regression_range': False,
             'solution': 'blame',
         }
         If nothing is found: {
             'found_suspects': False,
         }
     """
-    # TODO(wrengr): will this auto-dropping of unnecessary fields cause
-    # any issues for JSON serialization?
     result = {}
     result['found'] = (
         bool(self.project) or
         bool(self.components) or
         bool(self.cls) or
         bool(self.regression_range))
     if self.regression_range:
       result['regression_range'] = self.regression_range
     if self.project:
       result['suspected_project'] = self.project
     if self.components:
       result['suspected_components'] = self.components
     if self.cls:
       result['suspected_cls'] = [cl.ToDict() for cl in self.cls]
 
     tags = {
       'found_suspects': bool(self.cls),
       'has_regression_range': bool(self.regression_range),
       'found_project': bool(self.project),
       'found_components': bool(self.components),
       'solution': self.algorithm,
     }
 
     return result, tags