Skip to content

Commit db6171a

Browse files
committed
Mention ReporterPreferences::shouldReportAllAssertionStarts in docs
1 parent c220968 commit db6171a

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

docs/reporters.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ and calls itself "partial" reporter, so it can be invoked with
154154
155155
Each reporter instance contains instance of `ReporterPreferences`, a type
156156
that holds flags for the behaviour of Catch2 when this reporter run.
157-
Currently there are two customization options:
157+
Currently there are three customization options:
158158
159159
* `shouldRedirectStdOut` - whether the reporter wants to handle
160160
writes to stdout/stderr from user code, or not. This is useful for
@@ -165,6 +165,11 @@ Currently there are two customization options:
165165
assertions. Usually reporters do not report successful assertions
166166
and don't need them for their output, but sometimes the desired output
167167
format includes passing assertions even without the `-s` flag.
168+
* `shouldReportAllAssertionStarts` - whether the reporter wants to handle
169+
`assertionStarting` events. Most reporters do not, and opting out
170+
explicitly enables a fast-path in Catch2's handling of assertions.
171+
172+
> `shouldReportAllAssertionStarts` was introduced in Catch2 X.Y.Z
168173
169174
170175
### Per-reporter configuration

0 commit comments

Comments
 (0)