Browse Source

Document the PropEr plugin

Loïc Hoguin 6 years ago
parent
commit
2997892222
2 changed files with 33 additions and 0 deletions
  1. 2 0
      doc/src/guide/book.asciidoc
  2. 31 0
      doc/src/guide/proper.asciidoc

+ 2 - 0
doc/src/guide/book.asciidoc

@@ -54,6 +54,8 @@ include::eunit.asciidoc[EUnit]
 
 include::common_test.asciidoc[Common Test]
 
+include::proper.asciidoc[PropEr]
+
 include::triq.asciidoc[Triq]
 
 include::coverage.asciidoc[Code coverage]

+ 31 - 0
doc/src/guide/proper.asciidoc

@@ -0,0 +1,31 @@
+[[proper]]
+== PropEr
+
+https://proper-testing.github.io/[PropEr] is a QuickCheck-like library for
+property-based testing. Erlang.mk automates discovery and checking of
+PropEr properties.
+
+To run all tests (including PropEr):
+
+[source,bash]
+$ make tests
+
+To run all tests and static checks (including PropEr):
+
+[source,bash]
+$ make check
+
+You can also run PropEr separately:
+
+[source,bash]
+$ make proper
+
+To check properties from a single module:
+
+[source,bash]
+$ make proper t=foo_tests
+
+To check a single property:
+
+[source,bash]
+$ make proper t=foo_tests:bar