Progmasoft Git

catch3

Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.

Clonegit clone https://git.progmasoft.com/catch3

Updated docs with INFO/ CAPTURE changes

Commit
d60b24840938770431e2dc32a6f2b32db987d8e9
Author
Phil Nash ·
Parents
b5fd5a6496dd

Files · Download .tar.gz

Changes

 docs/logging.md | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/docs/logging.md b/docs/logging.md
index f688dff7..4be20c59 100644
--- a/docs/logging.md
+++ b/docs/logging.md
@@ -16,15 +16,11 @@ These macros come in three forms:
 
 **INFO(** _message expression_ **)**
 
-The message is logged to a buffer, but only reported with the next assertion that is logged. This allows you to log contextual information in case of failures which is not shown during a successful test run (for the console reporter, without -s).
-
-**SCOPED_INFO(** _message expression_ **)**
-
-As INFO, but is only in effect during the current scope. If a failure occurs beyond the end of the scope the message is not logged. In a looped block the message is reset on each iteration.
+The message is logged to a buffer, but only reported with the next assertion that is logged. This allows you to log contextual information in case of failures which is not shown during a successful test run (for the console reporter, without -s). Messages are removed from the buffer at the end of their scope, so may be used, for example, in loops.
 
 **WARN(** _message expression_ **)**
 
-The message is always reported.
+The message is always reported but does not fail the test.
 
 **FAIL(** _message expression_ **)**
 
@@ -45,6 +41,12 @@ This would log something like:
 
 <pre>"theAnswer := 42"</pre>
 
+## Deprecated macros
+
+**SCOPED_INFO and SCOPED_CAPTURE**
+
+These macros are now deprecated and are just aliases for INFO and CAPTURE (which were not previously scoped).
+
 ---
 
 [Home](../README.md)
\ No newline at end of file