mirror of
https://github.com/Bodigrim/tasty-bench.git
synced 2024-09-11 08:45:33 +03:00
Extend documentation for env
This commit is contained in:
parent
bac7abd938
commit
7a53af8a37
@ -1594,6 +1594,11 @@ whnfAppIO = ioFuncToBench id
|
||||
-- @Gauge.@'Gauge.env', and involves 'unsafePerformIO'. Consider using
|
||||
-- 'withResource' instead.
|
||||
--
|
||||
-- When working with a mutable environment, bear in mind that it is threaded
|
||||
-- through all iterations of a benchmark. @tasty-bench@ does not roll it back
|
||||
-- or reset, it's user's resposibility. You might have better luck
|
||||
-- with @Criterion.@'Criterion.perBatchEnv' or @Criterion.@'Criterion.perRunEnv'.
|
||||
--
|
||||
-- 'defaultMain' requires that the hierarchy of benchmarks and their names is
|
||||
-- independent of underlying 'IO' actions. While executing 'IO' inside 'bench'
|
||||
-- via 'nfIO' is fine, and reading test data from files via 'env' is also fine,
|
||||
|
Loading…
Reference in New Issue
Block a user