Skip to content

quest: plan the doc(hidden) ban - #8376

Merged
kixelated merged 3 commits into
mainfrom
quest-plan/doc-hidden-ban
Nov 9, 2026
Merged

kixelated merged 3 commits into
mainfrom
quest-plan/doc-hidden-ban

Conversation

@kixelated

@kixelated kixelated commented Nov 9, 2026 •

Copy link
Copy Markdown
Collaborator

Plans Ban doc(hidden) in Rust in the m2 api-shape epic, a follow-up of moq-dev/moq#8369, which un-hides moq-net's route stream. The maintainer asked to audit the other #[doc(hidden)] uses, then to ban it.

just check will fail on any #[doc(hidden)]. main has 54: 34 in vendored WebRTC code, and 20 of ours, mostly feature-gated fuzz, sim, and bench modules.

Decisions

Settled in /quest-complete on 2026-11-09 by the maintainer:

  • Vendored code (rs/moq-webrtc/src/vendor): ✅ the ban covers it (rejected: exclude vendor/).
  • Feature-gated test support (fuzz, sim, bench exports): ✅ stays pub behind its feature, documented like tokio's test-util (rejected: make it private by moving bench and fuzz bodies into the crate). The first prompt got "IDK", so it was re-asked with the tokio precedent.
  • JS @internal: ✅ Rust only (rejected: a separate JS audit; banning @internal too).
  • Milestone: ✅ m2/api-shape (rejected: m3).

Impact

Quests only. The planned work is breaking for any item it makes private or deletes. Wire: none.

Models

Size: M
Implementer: Claude Code, claude-opus-5-5, high effort

🤖 Generated with Claude Code

(Written by Claude Opus 5.5 with high effort)

Review

Rewritten by quest review after each round.

  • Reviewer: Codex, gpt-6.1-sol, medium effort
  • Session: 01a1c181-87c7-7800-9605-a3eee0b718c0, round 1
  • Head: aaff7fd
  • Base: origin/main at ba9a184
  • Score: 10/10, The change only adds a scoped implementation plan and links it from its parent quest, with no executable behavior changes or actionable defects.
  • Findings: none

kixelated and others added 2 commits November 9, 2026 09:40
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
BenchSentPackets is reached as moq_quic::connection::BenchSentPackets. #8369 is still open, so the plan says it un-hides the route stream. vendor/mod.rs records upstream revisions, not local edits.

Co-Authored-By: Claude Haiku 5.5 <noreply@anthropic.com>
@kixelated
kixelated marked this pull request as ready for review November 9, 2026 18:12
@kixelated
kixelated enabled auto-merge November 9, 2026 18:12
@coderabbitai

coderabbitai Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The API-shape quest README now links to a plan to ban Rust #[doc(hidden)]. The plan describes a proposed just check enforcement, scope and handling guidance, and related quest-document updates. It states that feature-gated test support remains public with feature-specific documentation and excludes JavaScript @internal from the ban.

Merge Risk: Minimal · up to eb03c

This change documents and links the proposed Rust doc(hidden) ban without implementing it. No concrete merge-blocking risk is established.

Pre-merge checks: Passed 5

Check name Status Explanation
Title check Passed The title clearly summarizes the plan to ban Rust #[doc(hidden)].
Description check Passed The description explains the planned ban, its scope, and key decisions, matching the changeset.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

Finishing Touches

Simplify code

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d6ab94c7-6cc5-41d0-a5e5-d97d0244b21f
Commits

Reviewing files that changed from the base of the PR and between ba9a184 and eb03c1e.

Files selected for processing: 2

  • quest/m2/api-shape/README.md
  • quest/m2/api-shape/doc-hidden.md

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

@kixelated
kixelated added this pull request to the merge queue Nov 9, 2026
@pullfrog

pullfrog Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

This run failed before Pullfrog could finish. The workflow's logs have the cause.

View the logs →

Pullfrog  | Rerun failed job ➔ | View workflow run | via Pullfrog

@kixelated kixelated left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review by review (OpenAI)

Reviewed head: eb03c1e.

No actionable findings in this plan-only change. The direction fits the existing API-shape rules: retain documented, feature-gated test support; make internal-only items private or delete unused ones; enforce the Rust-only ban through the existing text-check gate. Checked the parent quest, referenced follow-ups, current exports, vendor visibility, and check wiring.

Verification limits: static GitHub-only review; no builds, tests, or quest context execution. The ban and API changes are planned, not implemented by this PR.

Merged via the queue into main with commit 56902e9 Nov 9, 2026
3 checks passed
@kixelated
kixelated deleted the quest-plan/doc-hidden-ban branch November 9, 2026 20:10
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