improved documentation (#2717)

deepchecks · Dec 18, 2023 · 42cf4b3 · 42cf4b3
1 parent 7bb31d1
commit 42cf4b3
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/deepchecks/core/suite.py b/deepchecks/core/suite.py
@@ -442,7 +442,7 @@ def get_not_ran_checks(self) -> List['check_types.CheckFailure']:
         return cast(List[check_types.CheckFailure], self.select_results(self.failures))
 
     def get_not_passed_checks(self, fail_if_warning=True) -> List['check_types.CheckResult']:
-        """Get all the check results that have not passing condition.
+        """Get all the check results that have not passing condition. This does not include checks that failed to run.
 
         Parameters
         ----------
@@ -464,7 +464,7 @@ def get_not_passed_checks(self, fail_if_warning=True) -> List['check_types.Check
         ]
 
     def get_passed_checks(self, fail_if_warning=True) -> List['check_types.CheckResult']:
-        """Get all the check results that have passing condition.
+        """Get all the check results that have passing condition. This does not include checks that failed to run.
 
         Parameters
         ----------