Skip to content

Commit 21219c2

Browse files
committed
Clarify iteration setup/cleanup timing in xml docs.
1 parent 5f2b073 commit 21219c2

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

src/BenchmarkDotNet/Engines/Engine.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ private ClockSpan Measure(Action<long> action, long invokeCount)
225225
Parameters.InProcessDiagnoserHandler.Handle(BenchmarkSignal.AfterExtraIteration);
226226
Host.SendSignal(HostSignal.AfterExtraIteration);
227227

228-
data.cleanupAction(); // we run iteration cleanup after collecting GC stats
228+
data.cleanupAction(); // we run iteration cleanup after diagnosers are complete.
229229

230230
var totalOperations = data.invokeCount * Parameters.OperationsPerInvoke;
231231
var measurement = new Measurement(0, IterationMode.Workload, IterationStage.Extra, 1, totalOperations, clockSpan.GetNanoseconds());

src/BenchmarkDotNet/Engines/HostSignal.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ public enum HostSignal
2828
AfterActualRun,
2929

3030
/// <summary>
31-
/// after actual run, before extra iteration
31+
/// after actual run, after extra IterationSetup, before extra iteration
3232
/// </summary>
3333
BeforeExtraIteration,
3434

3535
/// <summary>
36-
/// after extra iteration
36+
/// after extra iteration, before extra IterationCleanup
3737
/// </summary>
3838
AfterExtraIteration,
3939

0 commit comments

Comments
 (0)