#333 Change arguments for ale#Queue so they are more obvious, and check files in more places

This commit is contained in:
w0rp
2017-03-21 13:38:27 +00:00
parent 2d1d6fb850
commit 3e13e10e03
3 changed files with 18 additions and 15 deletions

View File

@@ -1168,6 +1168,9 @@ ALELint *ALELint*
Run ALE once for the current buffer. This command can be used to run ALE
manually, instead of automatically, if desired.
This command will also run linters where `lint_file` is set to `1`, or in
other words linters which check the file instead of the Vim buffer.
A plug mapping `<Plug>(ale_lint)` is defined for this command.
@@ -1219,17 +1222,16 @@ ALEDetail *ALEDetail*
===============================================================================
7. API *ale-api*
ale#Queue(delay, [run_file_linters]) *ale#Queue()*
ale#Queue(delay, [linting_flag]) *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`.
An optional `linting_flag` argument can be given. If `linting_flag`
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.
ale#engine#EscapeCommandPart(command_part) *ale#engine#EscapeCommandPart()*