summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-03-14 23:51:57 +0000
committerw0rp <devw0rp@gmail.com>2017-03-14 23:51:57 +0000
commite7d32fe37677636a0be087163c1efa7d0ba10d47 (patch)
treea605ebb4cf464fc6b797942ec9a1d452d4bd6918 /doc
parent790c614b7a2360446aee6e003e3e834d21b2f04b (diff)
downloadale-e7d32fe37677636a0be087163c1efa7d0ba10d47.zip
#333 Pass in a flag indicating that linters should be run against files, and clear more jobs
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index b6e7a108..e4b458f7 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1218,12 +1218,18 @@ ALEDetail *ALEDetail*
===============================================================================
7. API *ale-api*
-ale#Queue(delay) *ale#Queue()*
+ale#Queue(delay, [run_file_linters]) *ale#Queue()*
+
Run linters for the current buffer, based on the filetype of the buffer,
with a given `delay`. A `delay` of `0` will run the linters immediately.
The linters will always be run in the background. Calling this function
again from the same buffer
+ An optional `run_file_linters` argument can be given. If `run_file_linters`
+ is `0`, then no linters where the `lint_file` option is set to `1` will be
+ run. If `run_file_linters` is set to `1`, then all linters for the current
+ file will be run. `run_file_linters` defaults to `0`.
+
ale#engine#EscapeCommandPart(command_part) *ale#engine#EscapeCommandPart()*