docs(linters): expand doc.go and spec_test to cover all 21 analyzers#37009
Merged
Conversation
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Document all 21 custom analyzers in pkg/linters/README.md and doc.go
docs(linters): expand doc.go and spec_test to cover all 21 analyzers
Jun 4, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR synchronizes the linter namespace documentation and the README-driven spec test with the full set of analyzers already documented in pkg/linters/README.md, ensuring the package docs and tests reflect all 21 analyzer subpackages.
Changes:
- Expand
pkg/linters/doc.goto list all 21 analyzer subpackages with one-line descriptions. - Update
pkg/linters/spec_test.goto include the 6 previously omitted analyzers indocumentedAnalyzers()(and their imports), aligning the spec test with the README.
Show a summary per file
| File | Description |
|---|---|
| pkg/linters/spec_test.go | Adds the missing analyzer imports and extends documentedAnalyzers() to cover all 21 README-documented analyzer subpackages. |
| pkg/linters/doc.go | Replaces the partial analyzer mention with a complete list of all active analyzers and brief descriptions. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 0
This was referenced Jun 5, 2026
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.
pkg/linters/doc.gomentioned only 4 of 21 analyzers;spec_test.gotested only 15. The README already had all 21 entries. This brings the other two files in sync.Changes
pkg/linters/doc.go— Replaces the 4-item mention with a full alphabetical list of all 21 analyzers, each with a one-line description of what it catches.pkg/linters/spec_test.go— Adds the 6 previously absent analyzers (contextcancelnotdeferred,fmterrorfnoverbs,jsonmarshalignoredeerror,seenmapbool,strconvparseignorederror,tolowerequalfold) todocumentedAnalyzers()with their imports, and updates the count comment from 15 → 21.