Skip to content

Commit

Permalink
Disable revive linter rule package-comments (#79)
Browse files Browse the repository at this point in the history
Even though the `package-comments` rule [1] of the `revive` linter [2]
is quite useful, it produces false-positive errors when another file
already has a package documentation. Duplicating documentation is not a
workaround so the rule has been disabled for now and might be re-enabled
if the rule logic gets updated.

[1]: https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#package-comments

Closes GH-78
  • Loading branch information
svengreb authored Nov 23, 2021
1 parent ab32672 commit 918ba3c
Showing 1 changed file with 0 additions and 1 deletion.
1 change: 0 additions & 1 deletion .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,6 @@ linters-settings:
severity: error
- name: increment-decrement
- name: indent-error-flow
- name: package-comments
- name: range
- name: receiver-naming
- name: redefines-builtin-id
Expand Down

0 comments on commit 918ba3c

Please sign in to comment.