Skip to content

Commit

Permalink
Add doc explaining use of "withTests 1" (issue #121)
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-martin committed Dec 4, 2017
1 parent d0dd96a commit 285deb0
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions hedgehog/src/Hedgehog/Internal/Property.hs
Original file line number Diff line number Diff line change
Expand Up @@ -731,6 +731,10 @@ mapConfig f (Property cfg t) =
-- | Set the number times a property should be executed before it is considered
-- successful.
--
-- If you have a test that does not involve any generators and thus does not
-- need to run repeatedly, you can use @withTests 1@ to define a property that
-- will only be checked once.
--
withTests :: TestLimit -> Property -> Property
withTests n =
mapConfig $ \config -> config { propertyTestLimit = n }
Expand Down

0 comments on commit 285deb0

Please sign in to comment.