77 lines
2.4 KiB
Markdown
77 lines
2.4 KiB
Markdown
# T1.4.1 — Add rustdoc on `MiniHeaderV2` / `MiniFrameContextV2` public items
|
|
|
|
**Status:** Approved
|
|
**Agent:** Kimi Code CLI
|
|
**Started:** 2026-05-11T07:26Z
|
|
**Completed:** 2026-05-11T07:27Z
|
|
**Commit:** see git log
|
|
**PRD:** ../PRD-wire-format-v2.md
|
|
|
|
## What I changed
|
|
|
|
- `crates/wzp-proto/src/packet.rs:641-645` — added `///` doc comments to all 3 fields of `MiniHeaderV2` (`seq_delta`, `timestamp_delta_ms`, `payload_len`)
|
|
- `crates/wzp-proto/src/packet.rs:648` — added `///` doc on `WIRE_SIZE`
|
|
- `crates/wzp-proto/src/packet.rs:650` — added `///` doc on `write_to`
|
|
- `crates/wzp-proto/src/packet.rs:656` — added `///` doc on `read_from`
|
|
- `crates/wzp-proto/src/packet.rs:705` — added `///` doc on `MiniFrameContextV2::update`
|
|
- `crates/wzp-proto/src/packet.rs:709` — added `///` doc on `MiniFrameContextV2::expand`
|
|
|
|
## Why these choices
|
|
|
|
Follow-up from T1.4 review: coding standard #9 requires `///` on all public items. Added concise one-line docs matching the task spec examples.
|
|
|
|
## Deviations from the task spec
|
|
|
|
None.
|
|
|
|
## Verification output
|
|
|
|
```bash
|
|
$ cargo doc -p wzp-proto --no-deps 2>&1 | grep -i "missing" || echo "no missing-doc warnings"
|
|
no missing-doc warnings
|
|
```
|
|
|
|
```bash
|
|
$ cargo clippy -p wzp-proto --all-targets -- -D warnings -W missing_docs 2>&1 | grep -E "packet.rs:6[4-9][0-9]|packet.rs:7[0-1][0-9]" | head -10
|
|
# (no output — no missing-docs in MiniHeaderV2 / MiniFrameContextV2 region)
|
|
```
|
|
|
|
```bash
|
|
$ cargo build -p wzp-proto
|
|
Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.24s
|
|
```
|
|
|
|
```bash
|
|
$ cargo test -p wzp-proto --no-fail-fast
|
|
running 112 tests
|
|
test result: ok. 112 passed; 0 failed; ...
|
|
```
|
|
|
|
```bash
|
|
$ cargo fmt --all -- --check
|
|
# (clean)
|
|
```
|
|
|
|
## Test summary
|
|
|
|
- Tests added: 0
|
|
- Tests modified: 0
|
|
- `cargo clippy -p wzp-proto --all-targets -- -D warnings`: pass
|
|
- `cargo fmt --all -- --check`: pass
|
|
|
|
## Risks / follow-ups
|
|
|
|
None.
|
|
|
|
## Reviewer checklist (filled in by reviewer)
|
|
|
|
- [x] Code matches PRD intent
|
|
- [x] Verification output is real (re-run if suspicious) — re-ran the region-scoped clippy grep; zero hits.
|
|
- [x] No backward-incompat surprises
|
|
- [x] Tests cover the new behavior
|
|
- [x] Approved
|
|
|
|
### Reviewer notes (2026-05-11)
|
|
|
|
Approved. All 3 fields + 3 `MiniHeaderV2` members + 2 `MiniFrameContextV2` methods carry `///` docs. Both Verify commands run. Closes the rustdoc trilogy (T1.1.1 / T1.2.1 / T1.4.1) — every public item added by Wave 1 v2 wire-format tasks now has documentation.
|