summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-08-08 23:52:28 +0100
committerw0rp <devw0rp@gmail.com>2017-08-08 23:52:28 +0100
commitac8cc6d9911376472ed85928f15b89a7cfa62516 (patch)
treebc8b3dc3e4f56de531c8864bce534c637a81e4cd
parent16772298ab555119223c50a7a8bf4800c436e2f9 (diff)
downloadale-ac8cc6d9911376472ed85928f15b89a7cfa62516.zip
Document the extra optional argument for ale#Queue
-rw-r--r--doc/ale.txt5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 1de7803d..0550e4de 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1166,7 +1166,7 @@ ALEInfoToClipboard *ALEInfoToClipboard*
===============================================================================
7. API *ale-api*
-ale#Queue(delay, [linting_flag]) *ale#Queue()*
+ale#Queue(delay, [linting_flag, buffer_number]) *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.
@@ -1177,6 +1177,9 @@ ale#Queue(delay, [linting_flag]) *ale#Queue()*
is `'lint_file'`, then linters where the `lint_file` option is set to `1` will be
run. Linters with `lint_file` set to `1` are not run by default.
+ An optional `buffer_number` argument can be given for specifying the buffer
+ to check. The active buffer (`bufnr('')`) will be checked by default.
+
ale#engine#CreateDirectory(buffer) *ale#engine#CreateDirectory()*