#74 - Document g:ale_buffer_loclist_map

This commit is contained in:
w0rp 2016-10-10 13:22:59 +01:00
parent 7acfa72c0d
commit 4c9aa1c638

View File

@ -92,6 +92,23 @@ g:ale_linters *g:ale_linters*
let g:ale_linters = {'javascript': []}
<
g:ale_buffer_loclist_map *g:ale_buffer_loclist_map*
Type: |Dictionary|
Default: `{}`
This variable is used internally by ALE for tracking the warnings and
errors for a particular buffer. The dictionary maps a buffer number to
a |List| of |Dictionary| items in the format accepted by |setqflist()|,
with a minor addition of a `linter_name` for each object which describes
the linter which reported the warnings and errors. (A buffer may run
multiple linters in combination on the same filetype.)
NOTE: This variable should not be modified outside of the plugin itself,
but can be read in other plugins whenever information about the current
errors and warnings ALE is reporting is needed.
g:ale_lint_on_text_changed *g:ale_lint_on_text_changed*
Type: |Number|