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:
@@ -75,12 +75,7 @@ e.g.:
|
||||
|
||||
### Notes
|
||||
|
||||
Notes are here.
|
||||
|
||||
1. This helper is useful for config snapshots, examples, and tests.
|
||||
|
||||
2. Use `pretty=true` when readability matters.
|
||||
|
||||
3. Compact mode is a better default for machine-oriented output.
|
||||
|
||||
4. This API exports config data, not formatted records.
|
||||
|
||||
Reference in New Issue
Block a user