Lint godoc comments #2972
Merged
Lint godoc comments #2972
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #2972 +/- ##
=======================================
Coverage 98.11% 98.11%
=======================================
Files 149 149
Lines 12790 12796 +6
=======================================
+ Hits 12549 12555 +6
Misses 166 166
Partials 75 75
|
gmlewis
approved these changes
Oct 23, 2023
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This adds linting for godoc comments. We had several cases where the method name didn't match the comment.
I had to make golangci-lint not use default exclusions in order to make it check godoc. There were only a couple of other default exclusions that affected go-github, so I only added those back.