update docstring

erees1 · Dec 5, 2023 · bb53647 · bb53647
1 parent de1b846
commit bb53647
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/slist/__init__.py b/slist/__init__.py
@@ -708,7 +708,8 @@ def split_by(self, predicate: Callable[[A], bool]) -> Tuple[Slist[A], Slist[A]]:
         return left, right
 
     def split_on(self, predicate: Callable[[A], bool]) -> Slist[Slist[A]]:
-        """Splits the list into lists of non empty lists"""
+        """Splits the list into sections based on the predicate,
+        items matching the predicate are not included in the output"""
         output = Slist[Slist[A]]()
         current = Slist[A]()
         for item in self: