Review Consistency
Compare changed code/docs claims with their immediate counterparts, including
unchanged ones made stale. Do not audit the whole repository unless asked.
Follow shared context and the
findings contract.
Procedure
- Map claims: pair changed behavior with docs, and changed docs with
implementation and related documents.
- Match scope: revision, version, features, target and audience must agree.
Historical changelogs and explicitly scoped exceptions are not current
contradictions. Reuse matching public-docs bundles; request fresh
review-public-docs retrieval when authoritative reachable-public-item docs
are needed.
- Compare contracts: signatures/examples, defaults/allowed values,
units/limits, feature gates, lifecycle/ordering and error/panic guarantees.
Follow re-exports, wrappers and configuration sources to the reachable
contract; compare related documents' instructions too.
- Resolve intent: neither code nor prose wins automatically. Use trusted
requirements and baseline evidence. Unknown intent warrants a focused
question, never weakening docs to fit implementation.
- Prove and correct: quote both conflicting claims, or the documented claim
and decisive code/probe evidence. Apply shared reproduction rules to runtime
assertions. Recommend the smallest coherent correction across all affected
surfaces.
Specialist checks and boundaries
- New public items need minimal reachable docs. New features need readable
examples (roughly 100 lines); exhaustive scenarios belong in integration tests.
Keep crate-doc example/extension lists current, and design docs focused on
tenets, constraints and an API sketch, not prose styling.
- Identify generated docs' authoritative source/generation step. Never request
derived-file hand-edits or flag generated README wording/casing. Assess current
behavior, not speculative APIs.
- Route API redesign, runtime defects, test adequacy and naming preferences to
review-api-design, review-correctness, review-tests and review-naming.
Supply shared-root-cause evidence without duplicating findings.
- Retrieval provides evidence, not judgment. Never feed source findings into
review-public-api or bypass its output-only boundary.
Proof and coverage
Give both locations/excerpts, concrete consumer impact and the correction's
affected surfaces. Static contradictions need no gratuitous execution; retain
uncertainty about behavior or intent.
Coverage: claims/documents compared, public-doc/example gaps, configuration,
unresolved intent and unverified behavior.
1---2name: review-consistency3description: Review changed code and documentation for conflicting contracts, stale claims, examples or defaults, documentation gaps and conflicting documents. Use for "check code and docs agree", "review documentation consistency", or when review-lens routes a change to documented behavior here. Not for prose styling, naming preferences, runtime defect hunting or output-only API audits.4---56# Review Consistency78Compare changed code/docs claims with their immediate counterparts, including9unchanged ones made stale. Do not audit the whole repository unless asked.1011Follow [shared context](../review-lens/review-context.md) and the12[findings contract](../review-delivery/findings-contract.md).1314## Procedure15161. **Map claims:** pair changed behavior with docs, and changed docs with17 implementation and related documents.182. **Match scope:** revision, version, features, target and audience must agree.19 Historical changelogs and explicitly scoped exceptions are not current20 contradictions. Reuse matching public-docs bundles; request fresh21 `review-public-docs` retrieval when authoritative reachable-public-item docs22 are needed.233. **Compare contracts:** signatures/examples, defaults/allowed values,24 units/limits, feature gates, lifecycle/ordering and error/panic guarantees.25 Follow re-exports, wrappers and configuration sources to the reachable26 contract; compare related documents' instructions too.274. **Resolve intent:** neither code nor prose wins automatically. Use trusted28 requirements and baseline evidence. Unknown intent warrants a focused29 question, never weakening docs to fit implementation.305. **Prove and correct:** quote both conflicting claims, or the documented claim31 and decisive code/probe evidence. Apply shared reproduction rules to runtime32 assertions. Recommend the smallest coherent correction across all affected33 surfaces.3435## Specialist checks and boundaries3637- New public items need minimal reachable docs. New features need readable38 examples (roughly 100 lines); exhaustive scenarios belong in integration tests.39 Keep crate-doc example/extension lists current, and design docs focused on40 tenets, constraints and an API sketch, not prose styling.41- Identify generated docs' authoritative source/generation step. Never request42 derived-file hand-edits or flag generated README wording/casing. Assess current43 behavior, not speculative APIs.44- Route API redesign, runtime defects, test adequacy and naming preferences to45 `review-api-design`, `review-correctness`, `review-tests` and `review-naming`.46 Supply shared-root-cause evidence without duplicating findings.47- Retrieval provides evidence, not judgment. Never feed source findings into48 `review-public-api` or bypass its output-only boundary.4950## Proof and coverage5152Give both locations/excerpts, concrete consumer impact and the correction's53affected surfaces. Static contradictions need no gratuitous execution; retain54uncertainty about behavior or intent.5556Coverage: claims/documents compared, public-doc/example gaps, configuration,57unresolved intent and unverified behavior.