3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2025-07-19 07:05:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Mention ReporterPreferences::shouldReportAllAssertionStarts in docs

Browse Source
This commit is contained in:
Martin Hořeňovský 2025-07-17 22:57:13 +02:00
parent c22096846c
commit db6171a706
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reporters.md
View File

@ -154,7 +154,7 @@ and calls itself "partial" reporter, so it can be invoked with
Each reporter instance contains instance of `ReporterPreferences`, a type
that holds flags for the behaviour of Catch2 when this reporter run.
Currently there are two customization options:
Currently there are three customization options:
* `shouldRedirectStdOut` - whether the reporter wants to handle
writes to stdout/stderr from user code, or not. This is useful for
@ -165,6 +165,11 @@ Currently there are two customization options:
assertions. Usually reporters do not report successful assertions
and don't need them for their output, but sometimes the desired output
format includes passing assertions even without the `-s` flag.
* `shouldReportAllAssertionStarts` - whether the reporter wants to handle
`assertionStarting` events. Most reporters do not, and opting out
explicitly enables a fast-path in Catch2's handling of assertions.
> `shouldReportAllAssertionStarts` was introduced in Catch2 X.Y.Z
### Per-reporter configuration