From 299789222216c40197a031a7454a18d4f4aa144d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 7 Dec 2018 14:44:31 +0100 Subject: Document the PropEr plugin --- doc/src/guide/proper.asciidoc | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 doc/src/guide/proper.asciidoc (limited to 'doc/src/guide/proper.asciidoc') diff --git a/doc/src/guide/proper.asciidoc b/doc/src/guide/proper.asciidoc new file mode 100644 index 0000000..37fa3d7 --- /dev/null +++ b/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 -- cgit v1.2.3