Skip to content

Commit f0234de

Browse files
committed
chore: fix style
add missing commas
1 parent 62a1c54 commit f0234de

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

pkg/golinters/nolintlint/internal/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# nolintlint
22

33
nolintlint is a Go static analysis tool to find ill-formed or insufficiently explained `//nolint` directives for golangci-lint
4-
(or any other linter, using this package)
4+
(or any other linter, using this package)
55

66
## Purpose
77

@@ -15,7 +15,7 @@ func hash(data []byte) []byte {
1515
}
1616
```
1717

18-
In the above case, nolint directives are present but the user has no idea why this is being done or which linter
18+
In the above case, nolint directives are present, but the user has no idea why this is being done or which linter
1919
is being suppressed (in this case, gosec recommends against use of md5). `nolintlint` can require that the code provide an explanation, which might look as follows:
2020

2121
```Go
@@ -26,6 +26,6 @@ func hash(data []byte) []byte {
2626
}
2727
```
2828

29-
`nolintlint` can also identify cases where you may have written `// nolint`. Finally `nolintlint`, can also enforce that you
29+
`nolintlint` can also identify cases where you may have written `// nolint`. Finally, `nolintlint`, can also enforce that you
3030
use the machine-readable nolint directive format `//nolint:all` and that you mention what linter is being suppressed, as shown above when we write `//nolint:gosec`.
3131

0 commit comments

Comments
 (0)