Document how to express consN

Bodigrim · Dec 16, 2013 · 106eff8 · 106eff8
1 parent 7f57686
commit 106eff8
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/Test/SmallCheck/Series.hs b/Test/SmallCheck/Series.hs
@@ -78,6 +78,14 @@ module Test.SmallCheck.Series (
   -- >
   -- >instance Serial m a => Serial m (Light a) where
   -- >  series = newtypeCons Light
+  --
+  -- For data types with more than 4 fields define @consN@ as
+  --
+  -- >consN f = decDepth $
+  -- >  f <$> series
+  -- >    <~> series
+  -- >    <~> series
+  -- >    <~> ...    {- series repeated N times in total -}
 
   -- ** What does consN do, exactly?