Skip to content

Gate missing docs on the library's exports - #187

Merged
kixelated merged 2 commits into
mainfrom
quest/m1/missing-docs
Nov 21, 2026
Merged

kixelated merged 2 commits into
mainfrom
quest/m1/missing-docs

Conversation

@kixelated

@kixelated kixelated commented Nov 21, 2026 •

Copy link
Copy Markdown
Collaborator

Finishes quest/m1/missing-docs.md: every item src/lib.rs exports now has a one-line doc comment, and #![warn(missing_docs)] keeps new ones from landing, since CI's clippy runs with -D warnings.

Summary

  • Recounted the lint on current main (after refactor: remove production code that exists only for tests #185): 50 items, not the 48 the quest listed: 24 enum variants and 9 fields in src/model.rs, 9 fields in src/cli.rs (the quest said 7), 4 in src/discovery.rs, 3 in src/prices.rs, 1 in src/reader.rs. Each now has a plain one-line doc, written from how the code uses it.
  • Added #![warn(missing_docs)] to src/lib.rs.
  • Deleted the finished quest.

Public API and wire impact

None. Doc comments and a lint attribute only; no signature, behavior, or wire change.

Validation

  • Added the lint alone: cargo clippy --all-targets reported the 50 missing docs above (counted per file from the warnings' locations).
  • With the docs, cargo clippy --all-targets -- -D warnings is clean, and quest gate just check passes (589 unit tests plus the integration tests).

Decisions

Taken on my recommendation while the user is away; a review can change any of them.

  • The wording of the 50 docs, such as Claude Code. for Harness::Claude, kept to what each item does in the code and no more.
  • The quest's count was stale; I documented all 50 the lint reports instead of stopping at 48.

Follow-ups

None.

Models

Size: S
Implementer: Claude Code, claude-sonnet-5-5, unknown effort (arm B)

(Written by Sonnet 5.5)

Review

Rewritten by quest review after each round.

  • Head: 99658df

  • Base: origin/main at c325c20

  • Risk: medium, the base has no RISK.md to name what is always high or customer-facing, so every change is medium

  • Classified: medium by default

  • Reviewer: Codex, gpt-6.1-sol, medium effort

  • Session: 01a1fec0-4d1d-7f01-9e13-3bf6201c891e, round 1

  • Score: 10/10, The change adds documentation and a missing-docs lint without altering runtime behavior; no actionable defects were found by code inspection, and builds and tests were not run as instructed.

  • Rounds: 1; first round 0; findings 0: fixed 0, refuted 0, open 0

  • Findings: none

  • Reviewer: Codex, gpt-6.1-sol, low effort, shadow

  • Session: 01a1fec0-4d1d-7133-83f1-e83d42d1f39d, round 1

  • Score: 10/10, The change adds documentation and enables the missing-docs lint without changing runtime behavior; code inspection found no actionable issues, and builds and tests were not run as instructed.

  • Rounds: 1; first round 0; findings 0: fixed 0, refuted 0, open 0

  • Findings: none

Summary by CodeRabbit

  • New Features
    • Discovery options now let callers specify the environment used to read settings overrides.
  • Documentation
    • Expanded documentation for report details, checks, actions, context, pricing options, and discovery settings.
    • Public API documentation checks are now enabled.

Quest-Claim: c0f1e3dd65cc0fd3
@coderabbitai

coderabbitai Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The crate enables the missing_docs lint and adds documentation comments to exported fields and variants. DiscoveryOptions also gains a public env: Env field. The missing-docs planning document is removed.

Changes: Exported API documentation

Layer / File(s) Summary
Enable lint and document exported API
src/lib.rs, src/discovery.rs, src/cli.rs, src/model.rs, src/prices.rs, src/reader.rs, quest/m1/missing-docs.md
The crate enables the missing_docs warning and adds documentation to exported fields and variants. DiscoveryOptions gains a public env: Env field. The planning document is deleted.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related PRs

Suggested reviewers: pullfrog

Merge Risk: Minimal · up to 99658

This change adds documentation and enables a lint that flags missing docs. It does not alter runtime behavior. The reported CI failure looks like a workflow gating issue and should be re-run or checked, but it does not point to a code defect.

Security architecture risk: Minimal · up to 99658

The changes document existing exports and enable documentation warnings. No introduced or worsened risk to security, state ownership, failure containment, or rollback was identified.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "Gate missing docs on the library's exports" matches the main change. The PR adds doc comments to the 50 items exported from src/lib.rs and enables the missing_docs lint at crate level so Cl…
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: Title check

Explanation

The title "Gate missing docs on the library's exports" matches the main change. The PR adds doc comments to the 50 items exported from src/lib.rs and enables the missing_docs lint at crate level so Clippy with -D warnings flags future omissions. The title is specific and concise, and it names the primary intent.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
Fix failing CI checks

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

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: e3e51b66-1a2e-4392-a7fa-74dea3043582
Commits

Reviewing files that changed from the base of the PR and between c325c20 and 99658df.

Files selected for processing: 7

  • quest/m1/missing-docs.md
  • src/cli.rs
  • src/discovery.rs
  • src/lib.rs
  • src/model.rs
  • src/prices.rs
  • src/reader.rs
Files with no reviewable changes: 1

  • quest/m1/missing-docs.md

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

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@kixelated
kixelated marked this pull request as ready for review November 21, 2026 15:36

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

✅ No new issues found.

Approach: sound. It documents the 50 exported items the lint reports and adds #![warn(missing_docs)], so CI's -D warnings clippy gates new ones.

Reviewed changes: the full diff, which only adds doc comments, one lint attribute, and removes the finished quest file.

  • Lint gate: src/lib.rs gains #![warn(missing_docs)].
  • Docs: one-line comments on the enum variants and fields in src/model.rs, src/cli.rs, src/discovery.rs, src/prices.rs and src/reader.rs. They are consistent with the surrounding comments and with how the code uses each item.
  • Quest cleanup: quest/m1/missing-docs.md is deleted.

I did not build or run the tests.

Pullfrog  | View workflow run | Using claude-sonnet-5-5 | 𝕏

@kixelated
kixelated added this pull request to the merge queue Nov 21, 2026
Merged via the queue into main with commit 4123fb4 Nov 21, 2026
10 of 11 checks passed
@kixelated
kixelated deleted the quest/m1/missing-docs branch November 21, 2026 15:43
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