marc/ale
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Document the extra optional argument for ale#Queue

Browse source
This commit is contained in:
w0rp 2017-08-08 23:52:28 +01:00
parent 16772298ab
commit ac8cc6d991
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/ale.txt
View file

@ -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()*