diff options
| author | w0rp <devw0rp@gmail.com> | 2019-02-22 15:24:34 +0000 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2019-02-22 15:24:34 +0000 |
| commit | f53b25d2567a2f7495dab444680596f48de427d1 (patch) | |
| tree | 87768bc6ddaceaf5502df785b6b9fee6c5e516d6 /doc | |
| parent | f8aeb5c5a45b57a35d1572176e345173c6e4de61 (diff) | |
| download | ale-f53b25d2567a2f7495dab444680596f48de427d1.zip | |
#2132 - Implement project_root as a replacement for project_root_callback
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale.txt | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index ca895fe0..acf86fb1 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -3270,16 +3270,21 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* This argument must only be set if the `lsp` argument is set to `'socket'`. - `project_root_callback` A |String| or |Funcref| for a callback function - accepting a buffer number. A |String| should be - returned representing the path to the project for the - file being checked with the language server. If an - empty string is returned, the file will not be + `project_root` A |String| representing a path to the project for + the file being checked with the language server, or + a |Funcref| accepting a buffer number and returning + the |String|. + + If an empty string is returned, the file will not be checked at all. This argument must only be set if the `lsp` argument is also set to a non-empty string. + `project_root_callback` A |String| or |Funcref| for a callback function + accepting a buffer number and returning the + `project_root` |String| as documented above. + `language` A |String| representing the name of the language being checked, or a |Funcref| accepting a buffer number and returning the |String|. This string will |