From 4c9aa1c638ba228a5d97e0fcc4d39e00664c8f31 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 10 Oct 2016 13:22:59 +0100 Subject: [PATCH] #74 - Document g:ale_buffer_loclist_map --- doc/ale.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/ale.txt b/doc/ale.txt index ead69dda..d52f8d77 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -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|