8000 Update allowed values for pydocstyle convention in CONFIGURATION.md (… · rookiecoder1st/python-lsp-server@6fc01fd · GitHub
[go: up one dir, main page]

Skip to content

Commit 6fc01fd

Browse files
authored
Update allowed values for pydocstyle convention in CONFIGURATION.md (python-lsp#295)
1 parent b24ffd3 commit 6fc01fd

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

CONFIGURATION.md

Copy file name to clipboard
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This server can be configured using the `workspace/didChangeConfiguration` metho
5050
| `pylsp.plugins.pycodestyle.maxLineLength` | `integer` | Set maximum allowed line length. | `null` |
5151
| `pylsp.plugins.pycodestyle.indentSize` | `integer` | Set indentation spaces. | `null` |
5252
| `pylsp.plugins.pydocstyle.enabled` | `boolean` | Enable or disable the plugin. | `false` |
53-
| `pylsp.plugins.pydocstyle.convention` | `string` (one of: `'pep257'`, `'numpy'`, `None`) | Choose the basic list of checked errors by specifying an existing convention. | `null` |
53+
| `pylsp.plugins.pydocstyle.convention` | `string` (one of: `'pep257'`, `'numpy'`, `'google'`, `None`) | Choose the basic list of checked errors by specifying an existing convention. | `null` |
5454
| `pylsp.plugins.pydocstyle.addIgnore` | `array` of unique `string` items | Ignore errors and warnings in addition to the specified convention. | `[]` |
5555
| `pylsp.plugins.pydocstyle.addSelect` | `array` of unique `string` items | Select errors and warnings in addition to the specified convention. | `[]` |
5656
| `pylsp.plugins.pydocstyle.ignore` | `array` of unique `string` items | Ignore errors and warnings | `[]` |

pylsp/config/schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@
289289
"pylsp.plugins.pydocstyle.convention": {
290290
"type": ["string", "null"],
291291
"default": null,
292-
"enum": ["pep257", "numpy", null],
292+
"enum": ["pep257", "numpy", "google", null],
293293
"description": "Choose the basic list of checked errors by specifying an existing convention."
294294
},
295295
"pylsp.plugins.pydocstyle.addIgnore": {

0 commit comments

Comments
 (0)
0