diff --git a/clients/lsp-bash.el b/clients/lsp-bash.el index 36475897b96..ff5aa86babb 100644 --- a/clients/lsp-bash.el +++ b/clients/lsp-bash.el @@ -34,7 +34,7 @@ :package-version '(lsp-mode . "6.2")) (defcustom lsp-bash-explainshell-endpoint nil - "The endpoint to use explainshell.com to answer 'onHover' queries. + "The endpoint to use explainshell.com to answer `onHover' queries. See instructions at https://marketplace.visualstudio.com/items?itemName=mads-hartmann.bash-ide-vscode" :type 'string :risky t @@ -42,7 +42,7 @@ See instructions at https://marketplace.visualstudio.com/items?itemName=mads-har :package-version '(lsp-mode . "6.2")) (defcustom lsp-bash-highlight-parsing-errors nil - "Consider parsing errors in scripts as 'problems'." + "Consider parsing errors in scripts as `problems'." :type 'boolean :group 'lsp-bash :package-version '(lsp-mode . "6.2")) diff --git a/clients/lsp-clangd.el b/clients/lsp-clangd.el index 9c8264541ff..6308b453868 100644 --- a/clients/lsp-clangd.el +++ b/clients/lsp-clangd.el @@ -111,9 +111,9 @@ be available here: https://github.com/clangd/clangd/releases/" "Extract the parts of the LLVM clang-tidy documentation that are relevant. This function assumes that the current buffer contains the result -of browsing 'clang.llvm.org', as returned by `url-retrieve'. +of browsing `clang.llvm.org', as returned by `url-retrieve'. More concretely, this function returns the main
element -with class 'section', and also removes 'headerlinks'." +with class `section', and also removes `headerlinks'." (goto-char (point-min)) (lsp-cpp-flycheck-clang-tidy--narrow-to-http-body) (lsp-cpp-flycheck-clang-tidy--decode-region-as-utf8 (point-min) (point-max)) diff --git a/clients/lsp-csharp.el b/clients/lsp-csharp.el index 01f3144b2e7..2916bdc4f0d 100644 --- a/clients/lsp-csharp.el +++ b/clients/lsp-csharp.el @@ -284,11 +284,11 @@ PRESENT-BUFFER will make the buffer be presented to the user." (message "lsp-csharp: No test method(s) found to be ran previously on this workspace"))) (lsp-defun lsp-csharp--handle-os-error (_workspace (&omnisharp:ErrorMessage :file-name :text)) - "Handle the 'o#/error' (interop) notification displaying a message." + "Handle the `o#/error' (interop) notification displaying a message." (lsp-warn "%s: %s" file-name text)) (lsp-defun lsp-csharp--handle-os-testmessage (_workspace (&omnisharp:TestMessageEvent :message)) - "Handle the 'o#/testmessage and display test message on test output buffer." + "Handle the `o#/testmessage and display test message on test output buffer." (lsp-csharp--test-message message)) (lsp-defun lsp-csharp--handle-os-testcompleted (_workspace (&omnisharp:DotNetTestResult @@ -298,7 +298,7 @@ PRESENT-BUFFER will make the buffer be presented to the user." :error-stack-trace :standard-output :standard-error)) - "Handle the 'o#/testcompleted' message from the server. + "Handle the `o#/testcompleted' message from the server. Will display the results of the test on the lsp-csharp test output buffer." (let ((passed (string-equal "passed" outcome))) @@ -371,7 +371,7 @@ using the `textDocument/references' request." (lsp-defun lsp-csharp--cls-metadata-uri-handler (uri) "Handle `csharp:/(metadata)' uri from csharp-ls server. -'csharp/metadata' request is issued to retrieve metadata from the server. +`csharp/metadata' request is issued to retrieve metadata from the server. A cache file is created on project root dir that stores this metadata and filename is returned so lsp-mode can display this file." diff --git a/clients/lsp-go.el b/clients/lsp-go.el index 4b0273159d6..6d3b4ae31a8 100644 --- a/clients/lsp-go.el +++ b/clients/lsp-go.el @@ -149,14 +149,14 @@ The returned type provides a tri-state that either: - sets element to false (actually, :json-false) - sets element to true \(actually, t)" (let ((list '())) - (dolist (v alist) - (push `(cons - :tag ,(cdr v) - (const :format "" ,(car v)) - (choice (const :tag "Enable" t) (const :tag "Disable" :json-false))) - list)) - (push 'set list) - list)) + (dolist (v alist) + (push `(cons + :tag ,(cdr v) + (const :format "" ,(car v)) + (choice (const :tag "Enable" t) (const :tag "Disable" :json-false))) + list)) + (push 'set list) + list)) (define-obsolete-variable-alias 'lsp-gopls-codelens @@ -169,12 +169,12 @@ The returned type provides a tri-state that either: "lsp-mode 7.0.1") (defcustom lsp-go-codelenses '((gc_details . :json-false) - (generate . t) - (regenerate_cgo . t) - (tidy . t) - (upgrade_dependency . t) - (test . t) - (vendor . t)) + (generate . t) + (regenerate_cgo . t) + (tidy . t) + (upgrade_dependency . t) + (test . t) + (vendor . t)) "Select what codelenses should be enabled or not. The codelenses can be found at https://github.com/golang/tools/blob/3fa0e8f87c1aae0a9adc2a63af1a1945d16d9359/internal/lsp/source/options.go#L106-L112." @@ -231,7 +231,7 @@ $GOPATH/pkg/mod along with the value of (defcustom lsp-go-link-target "pkg.go.dev" "Which website to use for displaying Go documentation." :type '(choice (const "pkg.go.dev") - (string :tag "A custom website")) + (string :tag "A custom website")) :group 'lsp-go :package-version '(lsp-mode "7.0.1")) @@ -266,7 +266,7 @@ $GOPATH/pkg/mod along with the value of :package-version '(lsp-mode "8.0.0")) (defcustom lsp-go-import-shortcut "Both" - "Specifies whether import statements should link to documentation or go to + "Specifies whether import statements should link to documentation or go to definitions." :type '(choice (const "Both") (const "Link") @@ -287,13 +287,13 @@ $GOPATH/pkg/mod along with the value of (defcustom lsp-go-symbol-style "Dynamic" "Controls how symbols are qualified in symbol responses. - 'Dynamic' uses whichever qualifier results in the highest scoring match for - the given symbol query. Here a 'qualifier' is any '/' or '.' delimited suffix - of the fully qualified symbol. i.e. 'to/pkg.Foo.Field' or just 'Foo.Field'. + `Dynamic' uses whichever qualifier results in the highest scoring match for + the given symbol query. Here a `qualifier' is any `/' or '.' delimited suffix + of the fully qualified symbol. i.e. `to/pkg.Foo.Field' or just `Foo.Field'. - 'Full' is fully qualified symbols, i.e. 'path/to/pkg.Foo.Field'. + `Full' is fully qualified symbols, i.e. `path/to/pkg.Foo.Field'. - 'Package' is package qualified symbols i.e. 'pkg.Foo.Field'." + `Package' is package qualified symbols i.e. `pkg.Foo.Field'." :type '(choice (const "Dynamic") (const "Full") (const "Package")) @@ -327,10 +327,10 @@ flake.nix file with: (use-package nix-sandbox) (defun my/nix--lsp-go-wrapper (args) (if-let ((sandbox (nix-current-sandbox))) - (apply 'nix-shell-command sandbox args) + (apply `nix-shell-command sandbox args) args)) (setq lsp-go-server-path \"gopls\" - lsp-go-server-wrapper-function 'my/nix--lsp-go-wrapper)" + lsp-go-server-wrapper-function `my/nix--lsp-go-wrapper)" :group 'lsp-go :type '(choice (function-item :tag "None" :value identity) diff --git a/clients/lsp-kotlin.el b/clients/lsp-kotlin.el index 69c8d8392ac..7f8b2ec1788 100644 --- a/clients/lsp-kotlin.el +++ b/clients/lsp-kotlin.el @@ -87,7 +87,7 @@ When enabled a debugger for Kotlin will be available." (defcustom lsp-kotlin-external-sources-use-kls-scheme t "[Recommended] Specifies whether URIs inside JARs should be represented -using the 'kls'-scheme." +using the `kls'-scheme." :type 'boolean :group 'lsp-kotlin :package-version '(lsp-mode . "6.1")) @@ -120,27 +120,32 @@ to Kotlin." ;; cache in this case is the dependency cache. Given as an initialization option. (defcustom lsp-kotlin-ondisk-cache-path nil - "Path to the ondisk cache if used. If lsp-kotlin-ondisk-cache-enabled is t, but path is nil, then the project root is used as a default." + "Path to the ondisk cache if used. If lsp-kotlin-ondisk-cache-enabled is t, +but path is nil, then the project root is used as a default." :type 'string :group 'lsp-kotlin) (defcustom lsp-kotlin-ondisk-cache-enabled nil - "Specifies whether to enable ondisk cache or not. If nil, in-memory cache will be used." + "Specifies whether to enable ondisk cache or not. If nil, in-memory cache +will be used." :type 'boolean :group 'lsp-kotlin) (defcustom lsp-kotlin-inlayhints-enable-typehints t - "Specifies whether to enable type hints or not. Requires lsp-inlay-hints-mode." + "Specifies whether to enable type hints or not. +Requires lsp-inlay-hints-mode." :type 'boolean :group 'lsp-kotlin) (defcustom lsp-kotlin-inlayhints-enable-parameterhints t - "Specifies whether to enable parameter hints or not. Requires lsp-inlay-hints-mode." + "Specifies whether to enable parameter hints or not. +Requires lsp-inlay-hints-mode." :type 'boolean :group 'lsp-kotlin) (defcustom lsp-kotlin-inlayhints-enable-chainedhints t - "Specifies whether to enable chained hints or not. Requires lsp-inlay-hints-mode." + "Specifies whether to enable chained hints or not. +Requires lsp-inlay-hints-mode." :type 'boolean :group 'lsp-kotlin) diff --git a/clients/lsp-lua.el b/clients/lsp-lua.el index 754cf65747f..56fc321fcdc 100644 --- a/clients/lsp-lua.el +++ b/clients/lsp-lua.el @@ -337,7 +337,7 @@ tolerance for this setting. Please adjust it to the appropriate value." :group 'lsp-lua-language-server) (defcustom lsp-lua-runtime-file-encoding "utf8" - "File encoding. The 'ansi' option is only available under the 'Windows' + "File encoding. The `ansi' option is only available under the `Windows' platform." :type '(choice (:tag "utf8" "ansi")) :package-version '(lsp-mode . "8.0.0") diff --git a/clients/lsp-pyls.el b/clients/lsp-pyls.el index dc93600b30e..392820f1177 100644 --- a/clients/lsp-pyls.el +++ b/clients/lsp-pyls.el @@ -250,7 +250,7 @@ convention." (defcustom lsp-pyls-plugins-pydocstyle-match "(?!test_).*\\.py" "Check only files that exactly match the given regular expression; default is to match files that don't start with -'test_' but end with '.py'." +`test_' but end with `.py'." :type 'string :group 'lsp-pyls :package-version '(lsp-mode . "6.1")) diff --git a/clients/lsp-pylsp.el b/clients/lsp-pylsp.el index 9441ee8a17e..58d5204c92b 100644 --- a/clients/lsp-pylsp.el +++ b/clients/lsp-pylsp.el @@ -206,7 +206,7 @@ convention." (defcustom lsp-pylsp-plugins-pydocstyle-match "(?!test_).*\\.py" "Check only files that exactly match the given regular expression; default is to match files that don't start with -'test_' but end with '.py'." +`test_' but end with `.py'." :type 'string :group 'lsp-pylsp) diff --git a/clients/lsp-sml.el b/clients/lsp-sml.el index cc3a60b43e4..19e8a3814ec 100644 --- a/clients/lsp-sml.el +++ b/clients/lsp-sml.el @@ -50,7 +50,8 @@ send only those, and do not send e.g. statistics diagnostics." "syntax")) :group 'lsp-sml) (defcustom lsp-sml-millet-server-diagnostics-moreInfoHint-enable t - "Show a hint on diagnostic messages about clicking the error code number for more information." + "Show a hint on diagnostic messages about clicking the error code number for +more information." :type 'boolean :group 'lsp-sml) diff --git a/clients/lsp-svelte.el b/clients/lsp-svelte.el index 723b8fc08e9..91d24239a9f 100644 --- a/clients/lsp-svelte.el +++ b/clients/lsp-svelte.el @@ -188,7 +188,7 @@ file paths or globs relative to workspace root." (defcustom lsp-svelte-plugin-svelte-compiler-warnings nil "Svelte compiler warning codes to ignore or to treat as errors. -Example: '((css-unused-selector . ignore) (unused-export-let . error))" +Example: `((css-unused-selector . ignore) (unused-export-let . error))" :type '(alist :key-type (symbol :tag "Warning code") :value-type (choice (const :tag "Ignore" ignore) diff --git a/clients/lsp-wgsl.el b/clients/lsp-wgsl.el index dafccdc70ec..56b9cdbf8ae 100644 --- a/clients/lsp-wgsl.el +++ b/clients/lsp-wgsl.el @@ -102,7 +102,8 @@ :package-version '(lsp-mode . "8.0.1")) (defcustom lsp-wgsl-shaderdefs [] - "Defines that should be valid for preprocessor operations like ifdef, e.g, ['USE_TYPES', 'DEBUG']" + "Defines that should be valid for preprocessor operations like ifdef, +e.g, ['USE_TYPES', 'DEBUG']" :type 'lsp-string-vector :group 'lsp-wgsl :package-version '(lsp-mode . "8.0.1")) @@ -132,7 +133,8 @@ ;; Various interactive functions to use the custom LSP extensions from the server (defun lsp-wgsl-full-source () - "Gets the full source of the file with all imports and preprocessor definitions resolved." + "Gets the full source of the file with all imports and preprocessor +definitions resolved." (interactive) (lsp-request-async "wgsl-analyzer/fullSource" diff --git a/clients/lsp-xml.el b/clients/lsp-xml.el index e791e115dba..db70f000686 100644 --- a/clients/lsp-xml.el +++ b/clients/lsp-xml.el @@ -250,7 +250,7 @@ This only affects the experimental formatter." (defcustom lsp-xml-validation-schema '((enabled . "always")) "The XML schema settings. -The value for 'enabled' can be always, never or onValidSchema." +The value for `enabled' can be always, never or onValidSchema." :type 'alist :group 'lsp-xml :package-version '(lsp-mode . "6.1"))