docs: non-tautological doc summaries across 5 domains (#29) - #250
Merged
Conversation
added 5 commits
April 21, 2026 22:59
Rewrite one-liner summaries in server/rpc/* that merely restated the function name. Each now adds scope (caller role, persistence semantics) or return-shape information per RFC 505 + M-DOC.
Rewrite doc summaries across setup/, bench/, status.rs, model.rs, common.rs, and start.rs that merely restated the function name. Each now carries scope (what is printed), constraint (RPC vs config fallback), or side-effect details per RFC 505 + M-DOC.
Rewrite one-liner summaries across dlp/, harness/, mcp/, and pledge/ that merely restated the function name. Each now adds scope (what is compared, what fingerprint indexes), constraint (catch-all rule), or return-shape details per RFC 505 + M-DOC.
Rewrite doc summaries across providers/, shared/, auth/, preset/, routing/classify/, and lib.rs that merely restated the function name. Each now carries scope (what is mapped/extracted), constraint (override semantics), or unit/edge details per RFC 505 + M-DOC.
Replace the tautological one-liner on `oauth_delete_token` with a summary that names the effect (token-store removal) and downstream consequence (re-authorization required).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrite ~45
///summaries that merely restated the function name, adding scope, constraint, unit, or edge-case information per RFC 505 + M-DOC (≤15 words, third person singular indicative, never "This function...").Covered domains:
src/server/rpc/*): pledge status/clear, keys create/revoke, HIT set/get, type-error buildersrc/commands/*): setup wizard + writer, bench scenario/escalation, status/model RPC fallback, common health probessrc/features/*): pledge CLI formatters, DLP hot_config/prompt_injection/signed_config/url_exfil, harness mock backend, MCP bench casessrc/providers/*,src/server/openai_compat/*): tool_use/tool_choice transforms, Codex SSE extractor, Gemini block mappersrc/lib.rs,src/shared/*,src/auth/*,src/preset/*,src/routing/*): home_dir override, ACME cache dir, zstd compressor, token classifier, TUI rendererTaxonomy validated N=5 at Phase 0 Reflect (scope / constraint / unit / edge-case).
Test plan
cargo fmt --checkcargo clippy --all-features -- -D warningscargo doc --no-deps --all-features(28 warnings — same as main baseline, no regression)Audit item: #29