README: .skip: add until example

ebonnal · Jan 17, 2025 · d1a9636 · d1a9636
1 parent 0837ec3
commit d1a9636
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -394,8 +394,6 @@ assert list(five_first_integers) == [0, 1, 2, 3, 4]
 
 ## `.skip`
 
-
-
 > Skips the first specified number of elements:
 
 ```python
@@ -404,6 +402,14 @@ integers_after_five: Stream[int] = integers.skip(5)
 assert list(integers_after_five) == [5, 6, 7, 8, 9]
 ```
 
+> or skips elements `until` a predicate is satisfied:
+
+```python
+integers_after_five: Stream[int] = integers.skip(until=lambda n: n >= 5)
+
+assert list(integers_after_five) == [5, 6, 7, 8, 9]
+```
+
 
 ## `.distinct`
 

diff --git a/tests/test_readme.py b/tests/test_readme.py
@@ -213,6 +213,10 @@ def test_skip_example(self) -> None:
 
         assert list(integers_after_five) == [5, 6, 7, 8, 9]
 
+        integers_after_five = integers.skip(until=lambda n: n >= 5)
+
+        assert list(integers_after_five) == [5, 6, 7, 8, 9]
+
     def test_distinct_example(self) -> None:
         distinct_chars: Stream[str] = Stream("foobarfooo").distinct()