📝 Refine API doc notes and guidance

This commit is contained in:
Nanaloveyuki
2026-05-12 13:32:15 +08:00
parent 4d913aa642
commit c6c153cf53
47 changed files with 0 additions and 236 deletions
-5
View File
@@ -73,12 +73,7 @@ e.g.:
### Notes
Notes are here.
1. This API is the most convenient direct output path for async logger snapshots.
2. Use `pretty=true` for humans and the default compact mode for machine-oriented logs.
3. Pair with `AsyncLogger::state()` to capture a consistent point-in-time snapshot.
4. This helper is ideal for startup, shutdown, and failure reporting.