summaryrefslogtreecommitdiff
path: root/doc/ale.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ale.txt')
-rw-r--r--doc/ale.txt15
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