Rewords docs

se-sic · Aug 19, 2024 · 300a313 · 300a313
1 parent 881be9e
commit 300a313
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/varats-core/varats/report/hot_functions_report.py b/varats-core/varats/report/hot_functions_report.py
@@ -36,7 +36,8 @@ def top_n_functions(self, limit=10) -> tp.List[XRayFunctionWrapper]:
     def hot_functions(self, threshold=2) -> tp.List[XRayFunctionWrapper]:
         """
         Args:
-            threshold: min percentage a function needs as self time to count as hot
+            threshold: min percentage a function needs as total
+                        time to count as hot
         """
         if threshold < 0 or threshold > 100:
             raise ValueError(
@@ -87,7 +88,8 @@ def hot_functions_per_workload(
     ) -> tp.Dict[str, tp.List[XRayFunctionWrapper]]:
         """
         Args:
-            threshold: min percentage a function needs as self time to count as hot
+            threshold: min percentage a function needs as
+                        total time to count as hot
         """
         res: tp.Dict[str, tp.List[XRayFunctionWrapper]] = {}
         for wl_name in self.workload_names():