[Chore] Mention a caveat regarding StringProps tests

See the comment, should be clear.
serokell · Mar 11, 2024 · d6b2891 · d6b2891
1 parent 63911c8
commit d6b2891
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/test/Test/Universum/StringProps.hs b/test/Test/Universum/StringProps.hs
@@ -1,3 +1,8 @@
+-- Some tests in this module have a caveat: they depend on compiler
+-- optimizations and will likely fail if compiled with -O0.
+-- That's because they test are rewrite rules, and these rules
+-- are usually not triggered without certain optimizations.
+
 module Test.Universum.StringProps
   ( hprop_StringToTextAndBack
   , hprop_StringToTextAndBackSurrogate