Skip to content

Commit aa9167a

Browse files
authored
Clarify effects of IterationSetup on UnrollFactor and InvocationCount (#1776)
As mentioned in #730 (comment)
1 parent 1a8296f commit aa9167a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/articles/samples/IntroSetupCleanupIteration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ uid: BenchmarkDotNet.Samples.IntroSetupCleanupIteration
55
## Sample: IntroSetupCleanupIteration
66

77
A method which is marked by the [`[IterationSetup]`](xref:BenchmarkDotNet.Attributes.IterationSetupAttribute)
8-
attribute will be executed exactly once *before each benchmark invocation* (we have changed that in 0.11.0).
8+
attribute will be executed exactly once *before each benchmark invocation*, forcing `UnrollFactor=1` and `InvocationCount=1` (we have changed that in 0.11.0).
99
It's not recommended to use this attribute in microbenchmarks because it can spoil the results.
1010
However, if you are writing a macrobenchmark (e.g. a benchmark which takes at least 100ms) and
1111
you want to prepare some data before each invocation,

0 commit comments

Comments
 (0)