Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorMartin Hořeňovský2025-07-17 22:57:13 +0200
committerMartin Hořeňovský2025-07-17 22:57:18 +0200
commitdb6171a706afb712d5ec13cc7b98e256e760fcb2 (patch)
tree6248ba0183ea3afe15c20c1ae49cb64b73e4c0f3
parentc22096846c98211e0bcd23dbbd155698fbd718b3 (diff)
downloadcatch3-db6171a706afb712d5ec13cc7b98e256e760fcb2.tar.gz
Mention ReporterPreferences::shouldReportAllAssertionStarts in docs
-rw-r--r--docs/reporters.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/reporters.md b/docs/reporters.md
index 20ef5e55..c600130c 100644
--- a/docs/reporters.md
+++ b/docs/reporters.md
@@ -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