Skip to content

Commit d33facc

Browse files
committed
fix eng
1 parent 439156b commit d33facc

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# contextcheck
55

6-
`contextcheck` is a static analysis tool, it is used to check whether the function uses a non-inherited context, which will result in a broken call link.
6+
`contextcheck` is a static analysis tool used to check whether a function uses a non-inherited context that could result in a broken call link.
77

88
For example:
99

@@ -94,8 +94,8 @@ func NoInheritCancel(_ context.Context) (context.Context,context.CancelFunc) {
9494
}
9595
```
9696

97-
### skip check specify function
98-
You can add `// nolint: contextcheck` in function decl doc comment, to skip this linter in some false-positive case.
97+
### skip the check for the specified function
98+
To skip this linter in some false-positive cases, you can add // nolint: contextcheck to the function declaration's comment.
9999

100100
```go
101101
// nolint: contextcheck
@@ -112,8 +112,8 @@ func call3() {
112112
}
113113
```
114114

115-
### force mark specify function have server-side http.Request parameter
116-
default behavior is mark http.HandlerFunc or a function use r.Context().
115+
### force the marking of a specified function as having a server-side http.Request parameter
116+
The default behavior is to mark `http.HandlerFunc` or any function that uses `r.Context()`.
117117

118118
```go
119119
// @contextcheck(req_has_ctx)

0 commit comments

Comments
 (0)