Merge pull request #202 from hedgehogqa/enumBounded-docs

Add note about enumBounded
hedgehogqa · Mar 10, 2019 · d17958b · d17958b
2 parents 6a4c483 + 37a1dc9
commit d17958b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/hedgehog/src/Hedgehog/Internal/Gen.hs b/hedgehog/src/Hedgehog/Internal/Gen.hs
@@ -957,6 +957,8 @@ enum lo hi =
 -- enumBounded :: 'Gen' 'Bool'
 -- @
 --
+--   /This is implemented in terms of the 'Enum' class, and thus may be
+--    partial for integral types larger than 'Int', e.g. 'Word64'./
 enumBounded :: (MonadGen m, Enum a, Bounded a) => m a
 enumBounded =
   enum minBound maxBound