Merge pull request #134 from chris-martin/pr/once

Add doc explaining use of "withTests 1"
hedgehogqa · Feb 1, 2018 · f70e1ce · f70e1ce
2 parents d31afdd + 7adf0ba
commit f70e1ce
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/hedgehog/src/Hedgehog/Internal/Property.hs b/hedgehog/src/Hedgehog/Internal/Property.hs
@@ -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 }