Skip to content

Commit

Permalink
Improve Documentation and fix typo (#1158)
Browse files Browse the repository at this point in the history
  • Loading branch information
akhilpandey1 committed Mar 6, 2023
1 parent 2470852 commit 93de676
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/index.md
Expand Up @@ -3429,7 +3429,7 @@ The closure passed to `ReportBeforeSuite` is called exactly once at the beginnin

Finally, and most importantly, when running in parallel both `ReportBeforeSuite` and `ReportAfterSuite` **only run on process #1**. Gingko guarantess that no other processes will start running their specs until after `ReportBeforeSuite` on process #1 has completed. Similarly, Ginkgo will only run `ReportAfterSuite` on process #1 after all other processes have finished and exited. Ginkgo provides a sinle `Report` that aggregates the `SpecReports` from all processes. This allows you to perform any custom suite reporting in one place after all specs have run and not have to worry about aggregating information across multiple parallel processes.

Givne all this, we can rewrite our invalid `ReportAfterEach` example from above into a valid `ReportAfterSuite` example:
Given all this, we can rewrite our invalid `ReportAfterEach` example from above into a valid `ReportAfterSuite` example:

```go
ReportAfterSuite("custom report", func(report Report) {
Expand Down

0 comments on commit 93de676

Please sign in to comment.