Add example for Gen.subsequence (#450)

hedgehogqa · May 22, 2022 · 2e32700 · 2e32700
1 parent 4c16408
commit 2e32700
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/hedgehog/src/Hedgehog/Internal/Gen.hs b/hedgehog/src/Hedgehog/Internal/Gen.hs
@@ -1661,6 +1661,20 @@ subterm3 gx gy gz f =
 
 -- | Generates a random subsequence of a list.
 --
+-- For example:
+--
+-- @
+-- Gen.print (Gen.subsequence [1..5])
+-- @
+--
+--   > === Outcome ===
+--   > [1,2,4]
+--   > === Shrinks ===
+--   > []
+--   > [2,4]
+--   > [1,4]
+--   > [1,2]
+--
 subsequence :: MonadGen m => [a] -> m [a]
 subsequence xs =
   shrink Shrink.list $ filterM (const bool_) xs