mirror of
https://github.com/astral-sh/ruff
synced 2026-01-20 21:10:48 -05:00
[pydoclint] Allow ignoring one line docstrings for DOC rules (#13302)
## Summary Add a setting to allow ignoring one line docstrings for the pydoclint rules. Resolves #13086 Part of #12434 ## Test Plan Run tests with setting enabled. --------- Co-authored-by: dylwil3 <dylwil3@gmail.com>
This commit is contained in:
24
ruff.schema.json
generated
24
ruff.schema.json
generated
@@ -2296,6 +2296,17 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"pydoclint": {
|
||||
"description": "Options for the `pydoclint` plugin.",
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/definitions/PydoclintOptions"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
},
|
||||
"pydocstyle": {
|
||||
"description": "Options for the `pydocstyle` plugin.",
|
||||
"anyOf": [
|
||||
@@ -2545,6 +2556,19 @@
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"PydoclintOptions": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"ignore-one-line-docstrings": {
|
||||
"description": "Skip docstrings which fit on a single line.\n\nNote: The corresponding setting in `pydoclint` is named `skip-checking-short-docstrings`.",
|
||||
"type": [
|
||||
"boolean",
|
||||
"null"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"PydocstyleOptions": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
||||
Reference in New Issue
Block a user