From fdf3f01101ee37c0a3e06415972a88be4a31bd7b Mon Sep 17 00:00:00 2001 From: Esdras Beleza de Noronha Date: Tue, 3 Mar 2020 22:42:16 +0000 Subject: [PATCH] Update documentation --- suite/interfaces.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/suite/interfaces.go b/suite/interfaces.go index 303459d..308d3f9 100644 --- a/suite/interfaces.go +++ b/suite/interfaces.go @@ -47,7 +47,9 @@ type AfterTest interface { AfterTest(suiteName, testName string) } -// WithStats is a suite which measures some stats for its tests. +// WithStats implements HandleStats, a function that will be executed +// when a test suite is finished. The stats contain information about +// the execution of that suite and its tests. type WithStats interface { HandleStats(suiteName string, stats *SuiteInformation) }