@@ -1269,30 +1269,38 @@ linters:
1269
1269
min-complexity : 10
1270
1270
1271
1271
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`)
1274
1275
default : all
1275
1276
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
1278
1279
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
1280
1282
- 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
1282
1285
- 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
1284
1288
- 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
1286
1291
- 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
1288
1294
- 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
1290
1297
- 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
1292
1300
- no-unused-link
1293
1301
1294
1302
# List of rules to disable.
1295
- # Default: null
1303
+ # Default: empty
1296
1304
disable :
1297
1305
- pkg-doc
1298
1306
- single-pkg-doc
@@ -1302,7 +1310,8 @@ linters:
1302
1310
- max-len
1303
1311
- no-unused-link
1304
1312
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.
1306
1315
options :
1307
1316
max-len :
1308
1317
# Maximum line length for godocs, not including the `// `, or `/*` or `*/` tokens.
0 commit comments