📝 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
@@ -72,12 +72,7 @@ e.g.:
### Notes
Notes are here.
1. This API is convenient for generated config text and tests.
2. Use `pretty=true` when the output is intended for humans.
3. The compact default is better for snapshots and transport.
4. This helper belongs to synchronous configured queue wrapping, not `bitlogger_async`.