T1.4.1: Add rustdoc on MiniHeaderV2 and MiniFrameContextV2 public items

This commit is contained in:
Siavash Sameni
2026-05-11 11:38:04 +04:00
parent 6b15b8f97c
commit 9680b6ff34
3 changed files with 84 additions and 2 deletions

View File

@@ -1236,12 +1236,12 @@ Statuses (in order of progression):
|---|---|---|---|---|---|---|
| T1.1 | Approved | Kimi Code CLI | 2026-05-11T06:09Z | 2026-05-11T06:54Z | [report](reports/T1.1-report.md) | Approved 2026-05-11. Spawned T1.1.1 (field rustdoc) and T1.1.2 (refresh stale test-count). |
| T1.1.1 | Approved | Kimi Code CLI | 2026-05-11T07:17Z | 2026-05-11T07:22Z | [report](reports/T1.1.1-report.md) | Approved after rework. Both Verify commands clean. |
| T1.1.2 | Changes Requested | Kimi Code CLI | 2026-05-11T07:19Z | | [report](reports/T1.1.2-report.md) | 3 stale "272 audio tests" refs still live in PRD-wire-format-v2.md (×2) and ROAD-TO-VIDEO.md. Grep was too narrow. See report. |
| T1.1.2 | Approved | Kimi Code CLI | 2026-05-11T07:19Z | 2026-05-11T07:25Z | [report](reports/T1.1.2-report.md) | Approved after rework. Broader grep clean; remaining matches are self-refs in task spec + frozen historical note. |
| T1.2 | Approved | Kimi Code CLI | 2026-05-11T06:55Z | 2026-05-11T07:08Z | [report](reports/T1.2-report.md) | Approved 2026-05-11. Spawned T1.2.1 (rustdoc on MediaType variants/methods). Agent also resolved the T1.2 TODO inside MediaHeaderV2 — good call. |
| T1.2.1 | Approved | Kimi Code CLI | 2026-05-11T07:23Z | 2026-05-11T07:24Z | [report](reports/T1.2.1-report.md) | Approved. Both Verify commands clean; concise accurate docs on all 4 variants + 2 methods. |
| T1.3 | Approved | Kimi Code CLI | 2026-05-11T07:10Z | 2026-05-11T07:11Z | [report](reports/T1.3-report.md) | Approved 2026-05-11. No follow-ups; docs-and-test-only change. |
| T1.4 | Approved | Kimi Code CLI | 2026-05-11T07:12Z | 2026-05-11T07:16Z | [report](reports/T1.4-report.md) | Approved 2026-05-11. Spawned T1.4.1 (rustdoc on v2 mini types). The two-step expand test catches the W4 desync scenario nicely. |
| T1.4.1 | Open | — | — | — | — | Spawned from T1.4 review; non-blocking |
| T1.4.1 | In Progress | Kimi Code CLI | 2026-05-11T07:26Z | — | — | — |
| T1.5 | Open | — | — | — | — | — |
| T1.6 | Open | — | — | — | — | — |
| T1.7 | Open | — | — | — | — | — |

View File

@@ -0,0 +1,72 @@
# T1.4.1 — Add rustdoc on `MiniHeaderV2` / `MiniFrameContextV2` public items
**Status:** Pending Review
**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)
- [ ] Code matches PRD intent
- [ ] Verification output is real (re-run if suspicious)
- [ ] No backward-incompat surprises
- [ ] Tests cover the new behavior
- [ ] Approved