Skip to content

moqt: tighten a few over-detailed/historical comments#27

Merged
floatdrop merged 1 commit into
draft-18from
docs/moqt-comment-cleanup
Jun 28, 2026
Merged

moqt: tighten a few over-detailed/historical comments#27
floatdrop merged 1 commit into
draft-18from
docs/moqt-comment-cleanup

Conversation

@floatdrop

Copy link
Copy Markdown
Owner

Summary

Applied the same comment review as #26 (stale comments + compression) to pkg/moqt/.

Finding: unlike pkg/relay/, this package is already in good shape — no stale filename/symbol references, no history notes, no pervasive verbosity. Its comments are tight, spec-cited godoc. So this is a deliberately small pass, not a sweep.

Changes

  • wire/varint.go: drop the "previously relied on from quicvarint.NewReader" history note from NewByteReader; state the no-look-ahead contract directly.
  • session/conn.go: condense the over-long PrioritizedSendStream status paragraph (keeps the key fact: no bundled adapter implements it yet, quic-go#437).
  • session/request.go: remove a speculative "add a code-taking variant if a future caller needs it" parenthetical from resetStream.

Verified clean (no changes needed)

  • wire/ codec, message/ (params/filter/subgroup/…), track, uri, loc, msf, and the rest of session/ — comments are accurate and appropriately scoped.
  • All draft-ietf-moq-* references match the pinned versions (transport-18 / loc-02 / msf-01).

Test plan

  • go build ./pkg/moqt/...
  • go vet ./pkg/moqt/...
  • gofmt -l
  • Comment-only change; no behavior affected.

🤖 Generated with Claude Code

pkg/moqt/ comments are already in good shape (tight, spec-cited godoc with
no stale filename or symbol references), so this is a small pass:

- wire/varint.go: drop the "previously relied on from quicvarint.NewReader"
  history note from NewByteReader, stating the contract directly.
- session/conn.go: condense the PrioritizedSendStream status paragraph.
- session/request.go: remove a speculative "add a code-taking variant"
  parenthetical from resetStream.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@floatdrop floatdrop merged commit 50ae14a into draft-18 Jun 28, 2026
9 checks passed
@floatdrop floatdrop deleted the docs/moqt-comment-cleanup branch June 28, 2026 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant