mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-05-30 15:42:25 +00:00
📝 Refine API doc notes and guidance
This commit is contained in:
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user