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:
@@ -70,12 +70,7 @@ e.g.:
|
||||
|
||||
### Notes
|
||||
|
||||
Notes are here.
|
||||
|
||||
1. This helper is convenient for documentation, examples, and generated config output.
|
||||
|
||||
2. Use `pretty=true` when humans are the primary audience.
|
||||
|
||||
3. The output describes the config schema, not live runtime sink state.
|
||||
|
||||
4. This API pairs naturally with `SinkConfig::new(...)` and `sink_config_to_json(...)`.
|
||||
|
||||
Reference in New Issue
Block a user