chore: rename CheckResult.get_dict to get_summary and add detail to the comment.

Signed-off-by: Nicholas Allen <[email protected]>

Author: nicallen

src/macaron/slsa_analyzer/analyze_context.py

@@ -181,7 +181,7 @@ def get_dict(self) -> dict:
         sorted_on_id = []
         for res in _sorted_on_id:
             # res is CheckResult
-            res_dict: dict = dict(res.get_dict())
+            res_dict: dict = dict(res.get_summary())
             res_dict.pop("result_tables")
             sorted_on_id.append(res_dict)
         sorted_results = sorted(sorted_on_id, key=lambda item: item["result_type"], reverse=True)

src/macaron/slsa_analyzer/checks/check_result.py

@@ -70,8 +70,11 @@ class CheckResult:
     #: The results produced by the check.
     result: CheckResultData
 
-    def get_dict(self) -> dict:
-        """Get a flattened dictionary representation for this CheckResult.
+    def get_summary(self) -> dict:
+        """Get a flattened dictionary representation for this CheckResult, in a format suitable for the output report.
+
+        The SLSA requirements, in particular, are translated into a list of their textual descriptions, to be suitable
+        for display to users in the output report (as opposed to the internal representation as a list of enum identifiers).
 
         Returns
         -------