1
0
mirror of https://github.com/mgechev/revive.git synced 2024-11-21 17:16:40 +02:00

Update RULES_DESCRIPTIONS.md (#1134)

Describe var-naming's limitation on evaluating test file functions.
This commit is contained in:
Iván Valdés Castillo 2024-11-17 22:50:51 -08:00 committed by GitHub
parent 0afba4ff15
commit 655e6060b2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -997,7 +997,7 @@ _Configuration_: N/A
## var-naming
_Description_: This rule warns when [initialism](https://go.dev/wiki/CodeReviewComments#initialisms), [variable](https://go.dev/wiki/CodeReviewComments#variable-names) or [package](https://go.dev/wiki/CodeReviewComments#package-names) naming conventions are not followed.
_Description_: This rule warns when [initialism](https://go.dev/wiki/CodeReviewComments#initialisms), [variable](https://go.dev/wiki/CodeReviewComments#variable-names) or [package](https://go.dev/wiki/CodeReviewComments#package-names) naming conventions are not followed. It ignores functions starting with `Example`, `Test`, `Benchmark`, and `Fuzz` in test files, preserving `golint` original behavior.
_Configuration_: This rule accepts two slices of strings and one optional slice with single map with named parameters.
(it's due to TOML hasn't "slice of any" and we keep backward compatibility with previous config version)