Skip to content

v0.1.0

Latest

Choose a tag to compare

@github-actions github-actions released this 21 Jun 09:31
· 3 commits to main since this release
docs(clipper): fix rustdoc links, stale env prefix, and flag rendering

Correctness and rendering pass over the in-code rustdocs; no behaviour
change. Building the HTML docs with link checking surfaced two broken
intra-doc links, and reading the modules surfaced stale facts:

- Fix broken intra-doc links: decode.rs `TriggerRecord` (qualified to its
  crate path, it is not imported there) and tail.rs `Tailer::tail_file`
  (renamed; the MAX_SCAN_FAULTS budget lives in `Tailer::run`).
- Correct the env-var prefix from `CLIPPER_*` to `MOMENTEDGE_*` in the
  `Config`/`load_config` docs and the clipper Cargo.toml comment (the
  `CLIPPER_E2E` test gate is a separate, correctly-named var).
- trigger-pub: the period default is 1 s, not 5 s.
- Replace the crate-doc "Settings" list — indented plain text that renders
  as a collapsed paragraph, and drifted to omit two flags — with a pointer
  to `Config`, the authoritative per-flag source rustdoc renders in full.
- Fence the trigger-pub flags list as a code block so it renders aligned.

cargo doc with broken-link/bare-url/missing-doc lints now builds clean.