docs: correct active rule count to 64 and complete the issue-type catalog#162
Merged
Conversation
…alog The docs claimed 57 detection rules (README, index, guides) while the IssueType enum has grown to 66 entries, 64 of which are actively emitted. filesort and temporary-table were still listed as reserved even though the MySQL/PostgreSQL EXPLAIN analyzers emit them, and n-plus-one-suspect and find-by-id-for-association were missing from the reference table. Reserved is now full-scan only. Also bumps install snippets to 0.4.0, fixes the docs badge label, and corrects the stale reserved-rule javadoc on IssueType.
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.
Approved Issue
Maintainer accuracy pass — no behavior change (docs + one stale javadoc).
What
duplicate-query), 1 reserved (full-scan). Previous copies said 57 (README, index, quickstart, spring-boot, references, architecture), 62 (overview accounting, configuration), or 64+ (CONTRIBUTING).n-plus-one-suspect,find-by-id-for-association,filesort,temporary-table. The EXPLAIN pair had shipped in the MySQL/PostgreSQL analyzers but was still documented (and javadoc'd) as reserved.query--guard.github.io→haroya01.github.io).Why
The counts had drifted in three directions at once, and the reserved-rule list contradicted the shipped EXPLAIN analyzers. Reviewers checking the numbers against
IssueType.javawould find the docs wrong on first inspection.How to test
grep -rnE '\b(57|62)\b' README.md docs CONTRIBUTING.mdreturns only table row numbers and an unrelated line-number example. Reference table has exactly 64 rows: 11 ERROR / 38 WARNING / 15 INFO.Checklist
./gradlew buildpasses (javadoc-only source change)