Skip to content

Commit 1c36d2e

Browse files
Fix warnings from #4345 (#4346)
Fixes the warnings: In toplevel form: lsp-pylsp.el:386:2: Warning: custom-declare-variable `lsp-pylsp-plugins-ruff-format' docstring wider than 80 characters lsp-pylsp.el:396:2: Warning: custom-declare-variable `lsp-pylsp-plugins-ruff-unsafe-fixes' docstring wider than 80 characters lsp-pylsp.el:402:2: Warning: custom-declare-variable `lsp-pylsp-plugins-ruff-line-length' docstring wider than 80 characters lsp-pylsp.el:409:2: Warning: custom-declare-variable `lsp-pylsp-plugins-ruff-exclude' docstring wider than 80 characters lsp-pylsp.el:416:2: Warning: custom-declare-variable `lsp-pylsp-plugins-ruff-select' docstring wider than 80 characters lsp-pylsp.el:423:2: Warning: custom-declare-variable `lsp-pylsp-plugins-ruff-ignore' docstring wider than 80 characters lsp-pylsp.el:430:2: Warning: custom-declare-variable `lsp-pylsp-plugins-ruff-per-file-ignores' docstring wider than 80 characters lsp-pylsp.el:437:2: Warning: custom-declare-variable `lsp-pylsp-plugins-ruff-preview' docstring wider than 80 characters lsp-pylsp.el:444:2: Warning: custom-declare-variable `lsp-pylsp-plugins-ruff-target-version' docstring wider than 80 characters
1 parent dbf13a3 commit 1c36d2e

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

clients/lsp-pylsp.el

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,9 @@ Requires pylsp >= 0.33.0"
384384
:group 'lsp-pylsp)
385385

386386
(defcustom lsp-pylsp-plugins-ruff-format nil
387-
"Rules that are marked as fixable by ruff that should be fixed when running textDocument/formatting."
387+
"Rules that should be fixed when running textDocument/formatting.
388+
389+
Note each rule must additionally be marked as fixable by ruff."
388390
:type 'lsp-string-vector
389391
:group 'lsp-pylsp)
390392

@@ -394,57 +396,66 @@ Requires pylsp >= 0.33.0"
394396
:group 'lsp-pylsp)
395397

396398
(defcustom lsp-pylsp-plugins-ruff-unsafe-fixes nil
397-
"Whether or not to offer unsafe fixes as code actions. Ignored with the \"Fix All\" action."
399+
"Whether or not to offer unsafe fixes as code actions.
400+
401+
Note this is ignored with the \"Fix All\" action."
398402
:type 'boolean
399403
:group 'lsp-pylsp)
400404

401405
;; Rules that are ignored when a pyproject.toml or ruff.toml is present
402406
(defcustom lsp-pylsp-plugins-ruff-line-length 88
403407
"Line length to pass to ruff checking and formatting.
404408
405-
Note this variable will be ignored when a when a pyproject.toml or ruff.toml is present."
409+
Note this variable will be ignored when a when a pyproject.toml or ruff.toml is
410+
present."
406411
:type 'integer
407412
:group 'lsp-pylsp)
408413

409414
(defcustom lsp-pylsp-plugins-ruff-exclude nil
410415
"Files to be excluded by ruff checking.
411416
412-
Note this variable will be ignored when a when a pyproject.toml or ruff.toml is present."
417+
Note this variable will be ignored when a when a pyproject.toml or ruff.toml
418+
is present."
413419
:type 'lsp-string-vector
414420
:group 'lsp-pylsp)
415421

416422
(defcustom lsp-pylsp-plugins-ruff-select nil
417423
"Rules to be enabled by ruff.
418424
419-
Note this variable will be ignored when a when a pyproject.toml or ruff.toml is present."
425+
Note this variable will be ignored when a when a pyproject.toml or ruff.toml
426+
is present."
420427
:type 'lsp-string-vector
421428
:group 'lsp-pylsp)
422429

423430
(defcustom lsp-pylsp-plugins-ruff-ignore nil
424431
"Rules to be ignored by ruff.
425432
426-
Note this variable will be ignored when a when a pyproject.toml or ruff.toml is present."
433+
Note this variable will be ignored when a when a pyproject.toml or ruff.toml
434+
is present."
427435
:type 'lsp-string-vector
428436
:group 'lsp-pylsp)
429437

430438
(defcustom lsp-pylsp-plugins-ruff-per-file-ignores nil
431439
"Rules that should be ignored for specific files.
432440
433-
Note this variable will be ignored when a when a pyproject.toml or ruff.toml is present."
441+
Note this variable will be ignored when a when a pyproject.toml or ruff.toml
442+
is present."
434443
:type '(alist :key-type (lsp-string-vector :tag "files") :value-type (string :tag "rule"))
435444
:group 'lsp-pylsp)
436445

437446
(defcustom lsp-pylsp-plugins-ruff-preview nil
438447
"Whether to enable the preview style linting and formatting.
439448
440-
Note this variable will be ignored when a when a pyproject.toml or ruff.toml is present."
449+
Note this variable will be ignored when a when a pyproject.toml or ruff.toml
450+
is present."
441451
:type 'boolean
442452
:group 'lsp-pylsp)
443453

444454
(defcustom lsp-pylsp-plugins-ruff-target-version nil
445455
"The minimum python version to target (applies for both linting and formatting).
446456
447-
Note this variable will be ignored when a when a pyproject.toml or ruff.toml is present."
457+
Note this variable will be ignored when a when a pyproject.toml or ruff.toml
458+
is present."
448459
:type 'string
449460
:group 'lsp-pylsp)
450461

0 commit comments

Comments
 (0)