From 7b1b9746a217763f22a783ed9198e75e7fdaa8d9 Mon Sep 17 00:00:00 2001 From: Jan Midtgaard Date: Wed, 25 Jun 2025 13:17:15 +0200 Subject: [PATCH 1/2] Elaborate on QCheck/QCheck2 situation in README --- README.adoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.adoc b/README.adoc index 4d6381f3..5d68d182 100644 --- a/README.adoc +++ b/README.adoc @@ -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 From e67e0f2514ddc53090054bd4fb9dd1b56f73e611 Mon Sep 17 00:00:00 2001 From: Jan Midtgaard Date: Wed, 25 Jun 2025 13:17:57 +0200 Subject: [PATCH 2/2] Add a CHANGELOG entry --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8b8513bc..28a12966 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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