Skip to content

Commit

Permalink
Update usage blurb to be clearer about what to expect from the bindin…
Browse files Browse the repository at this point in the history
…gs API
  • Loading branch information
TheSpyder committed Mar 17, 2023
1 parent 1658f1f commit a5c8dac
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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/).
Some development has been done during work hours by employees at [Tiny](https://github.com/tinymce/).

0 comments on commit a5c8dac

Please sign in to comment.