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:
@@ -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`.
|
||||
|
||||
Reference in New Issue
Block a user