From a5c8daca592befbe2f403f0a8bffd85a3fa0755b Mon Sep 17 00:00:00 2001 From: Andrew Herron Date: Fri, 17 Mar 2023 14:33:02 +1100 Subject: [PATCH] Update usage blurb to be clearer about what to expect from the bindings API --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0bcc207..5df76e6 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ These bindings aim to be zero cost as much as possible. The library is almost ex Everything is under the `FastCheck` namespace. Rather than use a flat namespace, as the fast-check API does, ReScript affords us the ability to use some logical module groupings while still compiling to the flat namespace. -The `rescript-fast-check` API groups are roughly mapped to the fast-check documentation, although not everything lines up as well as it used to after some of the fast-check documentation was restructured. +The `rescript-fast-check` API groups are roughly mapped to the fast-check usage guide, not the API reference, although not everything lines up as well as it used to after some of the fast-check documentation was restructured. ### `FastCheck.Arbitrary` This module covers [built-in arbitraries](https://github.com/dubzzz/fast-check/blob/master/documentation/Arbitraries.md) and [custom arbitraries](https://github.com/dubzzz/fast-check/blob/master/documentation/AdvancedArbitraries.md). Top level functions are simple arbitraries that generate values with no (or very little) input, sub-modules are used to group more complicated arbitraries together. @@ -112,4 +112,4 @@ All code is licensed as BSD. See [LICENSE](LICENSE). The original inspiration for this project came from [bs-jsverify](https://github.com/Risto-Stevcev/bs-jsverify) after jsverify was abandoned. -Some development has been done during work hours by employees at [Tiny](https://github.com/tinymce/). \ No newline at end of file +Some development has been done during work hours by employees at [Tiny](https://github.com/tinymce/).