From c2c4d3c0282e2b285b0b391f724eb66dfeed8947 Mon Sep 17 00:00:00 2001 From: MengjiaLiang Date: Thu, 26 Sep 2024 10:55:33 -0700 Subject: [PATCH] Fix the document by replacing `SpecsThatWillBeRun` with `SpecsThatWillRun` --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 8f71df21d..2eec98e31 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3627,7 +3627,7 @@ var _ = ReportAfterSuite("interruptible ReportAfterSuite", func(ctx SpecContext, }, NodeTimeout(1 * time.Minutes)) ``` -`Report` contains all available information about the suite. For `ReportAfterSuite` this will include individual `SpecReport` entries for each spec that ran in the suite, and the overall status of the suite (whether it passed or failed). Since `ReportBeforeSuite` runs before the suite starts - it does not contain any spec reports, however the count of the number of specs that _will_ be run can be extracted from `report.PreRunStats.SpecsThatWillBeRun`. +`Report` contains all available information about the suite. For `ReportAfterSuite` this will include individual `SpecReport` entries for each spec that ran in the suite, and the overall status of the suite (whether it passed or failed). Since `ReportBeforeSuite` runs before the suite starts - it does not contain any spec reports, however the count of the number of specs that _will_ be run can be extracted from `report.PreRunStats.SpecsThatWillRun`. The closure passed to `ReportBeforeSuite` is called exactly once at the beginning of the suite before any `BeforeSuite` nodes or specs run have run. The closure passed to `ReportAfterSuite` is called exactly once at the end of the suite after any `AfterSuite` nodes have run.