some lib docs

2025-09-07 00:22:54 +02:00
parent 8cc90d6f2f
commit a018dfd471
4 changed files with 28 additions and 2 deletions
--- a/src/lib/assert.h
+++ b/src/lib/assert.h
@@ -3,7 +3,8 @@
 #include <arch.h>
 #include <printf.h>

-// In arch code, make sure arch_api.panic and arch_api.console.putchar is set up befire calling
+// Make sure `arch_api.panic` and `arch_api.console.putchar` is intialized if calling from architecure-specific code.
+// Will be compiled out if `DEBUG` is not defined.
 static inline void assert(bool condition, const char* msg)
 {
 #if DEBUG