docs: improve linter/rule/check docs #5036
Merged
Conversation
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
ldez
force-pushed
the
feat/improve-linter-docs
branch
from
4322e1c to
df489d3
Compare
ldez
force-pushed
the
feat/improve-linter-docs
branch
from
df489d3 to
2bc2a75
Compare
|
We definitely need checkboxes in PR like "please grep gocritic, revive, staticcheck, govet", "be sure that it cannot be implemented by ruleguard and forbidigo" 🙂 |
bombsimon
approved these changes
Sep 23, 2024
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.
It's verbose but it's easier to find if a linter already implements a rule.
It's not perfect, but it's good enough for now.
govet: add descriptions for all passes.gocritic: add descriptions for all checks.staticcheck/stylecheck/gosimple: add description for all analyzers.promlinter: add descriptions for all rules.