Difficulty: easy · Estimate: 2–3 hours
BufferCfg is the central public-API type users meet first. Doctests on each variant would (a) compile-check that the README examples still work and (b) give first-time users an in-API reference. Strict scope, immediate user-facing impact.
Where to look
What to do
- For each variant of
BufferCfg, add a /// doc-comment with a 5–10 line cargo-runnable example showing how to construct it inside a configure::<T>(...) call.
- Ensure
cargo test --doc -p aimdb-core passes.
Done when
- Each
BufferCfg variant has a doctest
cargo test --doc is green- Examples render cleanly on docs.rs
We'd love help with this — comment if you'd like to take it.
Difficulty: easy · Estimate: 2–3 hours
BufferCfgis the central public-API type users meet first. Doctests on each variant would (a) compile-check that the README examples still work and (b) give first-time users an in-API reference. Strict scope, immediate user-facing impact.Where to look
BufferCfgWhat to do
BufferCfg, add a///doc-comment with a 5–10 linecargo-runnable example showing how to construct it inside aconfigure::<T>(...)call.cargo test --doc -p aimdb-corepasses.Done when
BufferCfgvariant has a doctestcargo test --docis greenWe'd love help with this — comment if you'd like to take it.