clearer doc for cell finding utilities

dpeerlab · Jun 13, 2024 · 5fe3b46 · 5fe3b46
1 parent 101ce30
commit 5fe3b46
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/src/palantir/utils.py b/src/palantir/utils.py
@@ -17,7 +17,7 @@
 
 
 class CellNotFoundException(Exception):
-    """Exception raised when no valid component is found for the provided cell type."""
+    """Exception raised when no cell could be determined by the used method."""
 
     pass
 
@@ -788,7 +788,9 @@ def early_cell(
         Key to access multiscale space diffusion components from obsm of ad.
         Default is 'DM_EigenVectors_multiscaled'.
     fallback_seed : int, optional
-        Seed for random number generator in fallback method. If not specified, no seed is used.
+        Seed for random number generator in fallback method. If not specified,
+        the fallback method is not applied and CellNotFoundException error is
+        raised instead.
         Default is None.
 
     Returns
@@ -935,8 +937,10 @@ def find_terminal_states(
         Key to access multiscale space diffusion components from obsm of ad.
         Default is 'DM_EigenVectors_multiscaled'.
     fallback_seed : int, optional
-        Seed for the random number generator used in the fallback method. Defaults to None, in which case
-        the random number generator will be randomly seeded.
+        Seed for random number generator in fallback method. If not specified,
+        the fallback method is not applied and CellNotFoundException error is
+        raised instead.
+        Defaults to None.
 
     Returns
     -------