diff --git a/build/relnotes_x.y.z.md b/build/relnotes_x.y.z.md index 5b52876..c419b7f 100644 --- a/build/relnotes_x.y.z.md +++ b/build/relnotes_x.y.z.md @@ -5,6 +5,7 @@ * **New features** * None * **Bug fixes** + * Add compile-time checks to prevent incorrect use of `QCOMPARE` from the Catch2 framework (#6 - thanks to Fabial Kosmale of Qt) * Now creates valid image files for new image-based approval tests (#7) * **Other changes** * None diff --git a/mdsource/README.source.md b/mdsource/README.source.md index 2b9fec7..e8689a0 100644 --- a/mdsource/README.source.md +++ b/mdsource/README.source.md @@ -36,6 +36,7 @@ You can download the [Starter Project](https://github.com/approvals/ApprovalTest ## Limitations * **IMPORTANT:** Do not use the [Qt Test macros](https://doc.qt.io/qt-5/qtest.html#macros), such as `QCOMPARE`, `QVERIFY`, `QTRY_COMPARE` and so on. **Currently, any test failures of all any of the Qt Test macros will be silently swallowed, and tests will spuriously pass.** +* Currently, there are compile-time checks to prevent incorrect use of `QCOMPARE`, but not the others. * Please note that this is a very early implementation, and there is not yet any promise of a stable interface. ## Reference