lib/prop_check.rb in prop_check-0.8.0 vs lib/prop_check.rb in prop_check-0.9.0
- old
+ new
@@ -7,9 +7,16 @@
# Main module of the PropCheck library.
#
# You probably want to look at the documentation of
# PropCheck::Generator and PropCheck::Generators
# to find out more about how to use generators.
+#
+# Common usage is to call `extend PropCheck` in your (testing) modules.
+#
+# This will:
+# 1. Add the local method `forall` which will call `PropCheck.forall`
+# 2. `include PropCheck::Generators`.
+#
module PropCheck
module Errors
class Error < StandardError; end
class UserError < Error; end
class GeneratorExhaustedError < UserError; end