Skip to content

docs: fix stale agent rules, the moq-net hop range, and the ffi unannounce doc - #4305

Merged
kixelated merged 2 commits into
mainfrom
claude/audit-doc-fixes
Sep 27, 2026
Merged

kixelated merged 2 commits into
mainfrom
claude/audit-doc-fixes

Conversation

@kixelated

@kixelated kixelated commented Sep 27, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

An audit of the PRs merged since 09-24 found docs that no longer match the code:

Approach

Correct each line to match the code. The two rs/AGENTS.md rules were approved by the maintainer during the audit.

Validation

Regenerated the Dart bindings (moq.dart), since they carry the doc comment. just check passes apart from moq-cli a_frame_read_times_out, a known load-only flake that the new test-flakes quest tracks.

Impact

  • Public API: none. Doc comment only.
  • Wire: none.

(Written by Opus 5.5)

🤖 Generated with Claude Code

…ounce doc

- rs/AGENTS.md: internal dev-dependencies are path-only (#4015), and tests
  crossing real networking run on the wall clock (#4244, #4291).
- rs/moq-net/AGENTS.md: point at fuzz/fuzz_targets/ instead of a stale list.
- moq-net CHANGELOG: random hops stay below 2^53 (#3933), not 62-bit.
- moq-ffi: unannounce on a standalone broadcast is a no-op.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kixelated
kixelated marked this pull request as ready for review September 27, 2026 00:45
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-27T00:47:05.124717Z ce93953 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 75ae1bb1-8089-49f4-9c6e-2b78f460ef95

📥 Commits

Reviewing files that changed from the base of the PR and between ce93953 and f7c8204.

📒 Files selected for processing (1)
  • dart/moq_ffi/lib/src/moq.dart

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.


Walkthrough

The changes update Rust workspace dependency and async testing guidance, revise fuzzing instructions, and clarify the unannounce documentation for standalone broadcasts. The changelog now describes random origin hop limits and client decoding ranges. The Dart UniFFI checksum check for moqbroadcastproducer_unannounce now expects 49647; the method implementation is unchanged.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to f7c82

The documentation and regenerated checksum changes introduce no actionable merge risk based on the complete diff.

Architecture Summary

Architecture risk: 🔵 Low · up to f7c82

The change affects 2 systems.

Changed systems: dart, rs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — dart (service) was modified; 1 changed file maps to changed impact.
  • observed — rs (service) was modified; 4 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in rs/AGENTS.md: The workspace dependency guidance now says internal dev-dependencies must be path-only, with _publish-test enforcing the release-publishing constraint.
  • observed — Modified behavior in rs/AGENTS.md: The testing guidance now exempts tests involving unmockable real networking, such as sockets and smoke tests, from pausing Tokio time; they run on wall-clock time and assert lower bounds.
  • observed — Modified behavior in rs/moq-ffi/src/producer.rs: The unannounce documentation replaces the claim that standalone broadcasts return Closed with the statement that the operation is a no-op on standalone broadcasts; executable code is unchanged.
  • observed — Modified behavior in rs/moq-net/AGENTS.md: The fuzzing instructions replace the explicit target names lite, ietf, varint, and path with a reference to one target per file in fuzz/fuzz_targets/; the nightly requirement and regression guidance remain.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (1 skipped: 1 …
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the documentation fixes for stale agent rules, the moq-net hop range, and the FFI unannounce documentation.
Description check ✅ Passed The description directly explains the documentation mismatches, the corrective changes, validation, and impact.
✨ Finishing Touches
✨ Simplify code
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kixelated
kixelated merged commit 11ede8d into main Sep 27, 2026
21 checks passed
@kixelated
kixelated deleted the claude/audit-doc-fixes branch September 27, 2026 01:24
This was referenced Sep 27, 2026
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