Skip to content

Elaborate on QCheck/QCheck2 situation in README too #349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jmid merged 2 commits into from
Jun 25, 2025
Merged

Elaborate on QCheck/QCheck2 situation in README too #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b1b974
Elaborate on QCheck/QCheck2 situation in README
jmid Jun 25, 2025
e67e0f2
Add a CHANGELOG entry
jmid Jun 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## NEXT RELEASE

- Elaborate on `QCheck`/`QCheck2` situation in README
- Add a missing `description` field to the *.opam files
- Document `Shrink` invariants in the `QCheck` module
- Fix a qcheck-ounit test suite failure on OCaml 5.4, removing a needless extra newline
Expand Down
6 changes: 6 additions & 0 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,12 @@ let test_buggy =
QCheck_base_runner.run_tests [test_buggy];;
----

Being newer the `QCheck2` module is less battle tested than `QCheck`.
`QCheck2` on the other hand removes the need for having to hand-write shrinkers.
`QCheck` tests can be ported to `QCheck2` by following the
https://c-cube.github.io/qcheck/dev/qcheck-core/QCheck2/index.html#migration_qcheck2[migration guide].
Please file an issue if you encounter problems using either of the two modules.


=== Preconditions

Expand Down