diff --git a/docs/overview.md b/docs/overview.md index 9740311d9..233ab40b6 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -95,6 +95,11 @@ They also detect code that may be correct, but looks suspicious. nilValReturn Detects return statements those results evaluate to nil + + :white_check_mark: + octalLiteral + + Detects octal literals passed to functions :white_check_mark: offBy1 @@ -557,7 +562,15 @@ func f(in int, out *int) (err error) {} Checker parameters: -* `@captLocal.paramsOnly` whether to restrict checker to params only (default true) + + ## caseOrder @@ -937,7 +950,15 @@ if cond1 { Checker parameters: -* `@elseif.skipBalanced` whether to skip balanced if-else pairs (default true) + + ## emptyFallthrough @@ -1161,7 +1182,15 @@ func f(x *[1024]int) {} Checker parameters: -* `@hugeParam.sizeThreshold` size in bytes that makes the warning trigger (default 80) + + ## ifElseChain @@ -1345,7 +1374,15 @@ for _, v := range a { Checker parameters: -* `@nestingReduce.bodyWidth` min number of statements inside a branch to trigger a warning (default 5) + + ## nilValReturn @@ -1381,6 +1418,31 @@ if err != nil { + +## octalLiteral + +[ + **diagnostic** + **experimental** ] + +Detects octal literals passed to functions. + + + + + +**Before:** +```go +foo(02) +``` + +**After:** +```go +foo(2) +``` + + + ## offBy1 @@ -1488,8 +1550,20 @@ for _, x := range &xs { // No copy Checker parameters: -* `@rangeExprCopy.sizeThreshold` size in bytes that makes the warning trigger (default 512) -* `@rangeExprCopy.skipTestFuncs` whether to check test functions (default true) + + ## rangeValCopy @@ -1522,8 +1596,20 @@ for i := range xs { Checker parameters: -* `@rangeValCopy.sizeThreshold` size in bytes that makes the warning trigger (default 128) -* `@rangeValCopy.skipTestFuncs` whether to check test functions (default true) + + ## regexpMust @@ -1810,7 +1896,15 @@ v := a[5] Checker parameters: -* `@underef.skipRecvDeref` whether to skip (*x).method() calls where x is a pointer receiver (default true) + + ## unlabelStmt @@ -1896,7 +1990,15 @@ func f() (x, y float64) Checker parameters: -* `@unnamedResult.checkExported` whether to check exported functions (default false) + + ## unnecessaryBlock diff --git a/docs/templates/checker.partial.tmpl b/docs/templates/checker.partial.tmpl index 93372073d..2945ee678 100644 --- a/docs/templates/checker.partial.tmpl +++ b/docs/templates/checker.partial.tmpl @@ -27,9 +27,17 @@ {{ if .Params }} Checker parameters: + +{{ end }} + +{{- end }}