From a8796feb371f760eff08f301654566a729f06740 Mon Sep 17 00:00:00 2001 From: neru Date: Thu, 21 May 2026 13:14:51 -0300 Subject: [PATCH] docs: change wording --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 89e593e..62b1c7f 100644 --- a/README.md +++ b/README.md @@ -111,8 +111,8 @@ The assert module provides diagnostic macros made to trap critical logic failure #### Macros and their behavior | Macro | Debug Mode (`_DEBUG`) | Release Mode | | :--- | :--- | :--- | -| `ASSERT(cond, msg)` | Evaluates `cond`. If `false`, logs the error location, pops up an interactive modal error box, drops a debugger breakpoint trap, and calls `std::exit`. | Evaluates to a compiler optimization hint informing the optimizer that `cond` is always `true`. | -| `PANIC(msg)` | Logs the error, displays an interactive modal error box, breaks execution, and terminates. | Logs the error, displays an interactive modal error box, breaks execution, and terminates. **Always halts execution.** | +| `ASSERT(cond, msg)` | Evaluates `cond`. If `false`, logs the error location, pops up an error box, drops a debugger breakpoint trap, and calls `std::exit`. | Evaluates to a compiler optimization hint informing the optimizer that `cond` is always `true`. | +| `PANIC(msg)` | Logs the error, displays an error box, breaks execution, and terminates. | Logs the error, displays an error box, breaks execution, and terminates. **Always halts execution.** | #### Example ```c++ #include @@ -145,7 +145,7 @@ void processNetworkPacket(int packetId) { } int main() { - // Fails in debug: triggers a modal error window detailing the file and line number + // Fails in debug: displays an error window detailing the file and line number processSystemData(nullptr, -1); return 0;