Skip to content

Commit cad6711

Browse files
committed
review
1 parent 5053586 commit cad6711

File tree

2 files changed

+32
-39
lines changed

2 files changed

+32
-39
lines changed

.golangci.next.reference.yml

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1269,30 +1269,38 @@ linters:
12691269
min-complexity: 10
12701270

12711271
godoclint:
1272-
# Default set of rules to enable. Possible values are: `basic`, `all` or `none`.
1273-
# Default: basic (enables `pkg-doc`, `single-pkg-doc`, and `start-with-name`)
1272+
# Default set of rules to enable.
1273+
# Possible values are: `basic`, `all` or `none`.
1274+
# Default: `basic` (enables `pkg-doc`, `single-pkg-doc`, and `start-with-name`)
12741275
default: all
12751276

1276-
# List of rules to enable in addition to default set. See the linter docs for more details.
1277-
# Default: null
1277+
# List of rules to enable in addition to the default set.
1278+
# Default: empty
12781279
enable:
1279-
# Check proper package-level godoc, if any
1280+
# Check proper package-level godoc, if any.
1281+
# https://github.com/godoc-lint/godoc-lint?tab=readme-ov-file#pkg-doc
12801282
- pkg-doc
1281-
# Assert at most one godoc per package
1283+
# Assert at most one godoc per package.
1284+
# https://github.com/godoc-lint/godoc-lint?tab=readme-ov-file#single-pkg-doc
12821285
- single-pkg-doc
1283-
# Require all packages to have a godoc
1286+
# Require all packages to have a godoc.
1287+
# https://github.com/godoc-lint/godoc-lint?tab=readme-ov-file#require-pkg-doc
12841288
- require-pkg-doc
1285-
# Assert symbol godocs start with the symbol name
1289+
# Assert symbol godocs start with the symbol name.
1290+
# https://github.com/godoc-lint/godoc-lint?tab=readme-ov-file#start-with-name
12861291
- start-with-name
1287-
# Require godoc for all public symbols
1292+
# Require godoc for all public symbols.
1293+
# https://github.com/godoc-lint/godoc-lint?tab=readme-ov-file#require-doc
12881294
- require-doc
1289-
# Assert maximum line length for godocs
1295+
# Assert maximum line length for godocs.
1296+
# https://github.com/godoc-lint/godoc-lint?tab=readme-ov-file#max-len
12901297
- max-len
1291-
# Assert no unused link in godocs
1298+
# Assert no unused link in godocs.
1299+
# https://github.com/godoc-lint/godoc-lint?tab=readme-ov-file#no-unused-link
12921300
- no-unused-link
12931301

12941302
# List of rules to disable.
1295-
# Default: null
1303+
# Default: empty
12961304
disable:
12971305
- pkg-doc
12981306
- single-pkg-doc
@@ -1302,7 +1310,8 @@ linters:
13021310
- max-len
13031311
- no-unused-link
13041312

1305-
# A map for fine tuning individual rules. All sub-keys are optional.
1313+
# A map for fine-tuning individual rules.
1314+
# All subkeys are optional.
13061315
options:
13071316
max-len:
13081317
# Maximum line length for godocs, not including the `// `, or `/*` or `*/` tokens.

jsonschema/golangci.next.jsonschema.json

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1870,36 +1870,20 @@
18701870
"description": "Default set of rules to enable."
18711871
},
18721872
"enable": {
1873-
"default": null,
18741873
"description": "List of rules to enable in addition to the default set.",
1875-
"oneOf": [
1876-
{
1877-
"type": "array",
1878-
"uniqueItems": true,
1879-
"items": {
1880-
"$ref": "#/definitions/godoclint-rules"
1881-
}
1882-
},
1883-
{
1884-
"type": "null"
1885-
}
1886-
]
1874+
"type": "array",
1875+
"uniqueItems": true,
1876+
"items": {
1877+
"$ref": "#/definitions/godoclint-rules"
1878+
}
18871879
},
18881880
"disable": {
1889-
"default": null,
18901881
"description": "List of rules to disable.",
1891-
"oneOf": [
1892-
{
1893-
"type": "array",
1894-
"uniqueItems": true,
1895-
"items": {
1896-
"$ref": "#/definitions/godoclint-rules"
1897-
}
1898-
},
1899-
{
1900-
"type": "null"
1901-
}
1902-
]
1882+
"type": "array",
1883+
"uniqueItems": true,
1884+
"items": {
1885+
"$ref": "#/definitions/godoclint-rules"
1886+
}
19031887
},
19041888
"options": {
19051889
"type": "object",

0 commit comments

Comments
 (0)