📝 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
@@ -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(...)`.