diff options
| author | w0rp <devw0rp@gmail.com> | 2018-04-27 22:52:11 +0100 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2018-04-27 22:52:11 +0100 |
| commit | 6ab3fdc4d0566c09e9456c3bf1b7aa92747fd0aa (patch) | |
| tree | 84362ca60df1e82d69e709e11688062d59c1ba79 /doc | |
| parent | d1d705cc8484d935c0c18857f152027491df355e (diff) | |
| download | ale-6ab3fdc4d0566c09e9456c3bf1b7aa92747fd0aa.zip | |
Close #1521 - Allow the language to be set with simple strings for LSP linters
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale.txt | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index de6507e3..ca15048a 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2272,9 +2272,9 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* process for a language server runnning, and communicates with it directly via a |channel|. - When this argument is not empty, then the - `project_callback` and `language_callback` arguments - must also be defined. + When this argument is not empty, `project_callback` + must be defined, and only one of either `language` or + `language_callback` must be defined. LSP linters handle diagnostics automatically, so the `callback` argument must not be defined. @@ -2289,13 +2289,20 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* This argument must only be set if the `lsp` argument is also set to a non-empty string. + `language` A |String| representing the name of the language + being checked. This string will be sent to the LSP to + tell it what type of language is being checked. + + This argument must only be set if the `lsp` argument + is also set to a non-empty string. + `language_callback` A |String| or |Funcref| for a callback function accepting a buffer number. A |String| should be returned representing the name of the language being checked. - This argument must only be set if the `lsp` argument - is also set to a non-empty string. + This option can be used instead of `language` if a + linter can check multiple languages. `aliases` A |List| of aliases for the linter name. |