docs: fix 10 documentation-codebase drifts found by audit#3692
Merged
Conversation
- Fix test count overclaims (2,900/3,000 → 2,600/2,700; actual: 2,666) - Fix README-MCP.md command count table (60/66 → 62/71) - Fix marketplace.json metadata count (66 → 70) - Add pragmastat to PERFORMANCE.md OOM list - Remove incorrect 📇 index icon from sortcheck (2 locations) - Fix binary size percentage contradiction (~13%/~12% → ~16%/~16%) - Fix "the the" typo in README.md - Fix skills README examples count (180 → 174) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ndex Address review #1405: - Replace absolute paths with repo-relative paths in audit report - Verify pragmastat 📇 icon is correct (uses indexed() at line 573) - Test count of 2,666 confirmed across two runs with -F all_features Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only PR that corrects a set of audited documentation/codebase drifts to keep published claims (counts, icons, and metadata) aligned with the current repository state.
Changes:
- Updates README claims (test counts,
sortcheckindex icon, binary size percentages, typo cleanup). - Updates performance/help docs to reflect current command behavior and pinned Polars revision badge.
- Updates Claude/MCP plugin docs and marketplace metadata to reflect current command/example counts, and adds an audit report artifact.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Fixes inaccurate test counts, removes incorrect 📇 marker for sortcheck, resolves size percentage inconsistency, and fixes a typo. |
| docs/PERFORMANCE.md | Adds pragmastat to the OOM/non-streaming list (🤯) to match command behavior. |
| docs/help/TableOfContents.md | Removes incorrect 📇 marker for sortcheck and updates Polars badge revision hash. |
| docs/help/sortcheck.md | Removes incorrect 📇 marker from the command header. |
| docs/help/foreach.md | Removes incorrect 📇 marker from the command header. |
| docs/audits/AUDIT_REPORT_2026-04-09.md | Adds the audit report documenting the verified false claims and applied fixes. |
| .claude/skills/README.md | Updates the usage examples total count to match the skill JSONs. |
| .claude/skills/README-MCP.md | Updates qsv/qsvmcp command counts in the summary table to match current code. |
| .claude-plugin/marketplace.json | Updates marketplace metadata description command count to match the plugin description. |
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
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
fbbaf5f68pragmastatto PERFORMANCE.md OOM list, removes incorrect index icon fromsortcheck, fixes binary size percentage contradiction and "the the" typo, and corrects skills README examples count (180 → 174)Test plan
cargo test -F all_features -- --list= 2,666 (confirmed across two runs)grep -c 'Command::' src/main.rs= 71; 71 - 9 excluded = 62 for qsvmcpsortcheckhas no index usage (grep -i index src/cmd/sortcheck.rs= no matches)pragmastatusesindexed()at line 573 (📇 icon correct, but was missing from OOM list)🤖 Generated with Claude Code