diff options
Diffstat (limited to 'doc/ale.txt')
| -rw-r--r-- | doc/ale.txt | 24 |
1 files changed, 7 insertions, 17 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index c879a98b..ca558f26 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -145,23 +145,6 @@ g:ale_linter_aliases *g:ale_linter_aliases* different set of linters from the type it is being mapped to. -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| @@ -556,6 +539,13 @@ ale#Queue(delay) *ale#Queue()* again from the same buffer +ale#engine#GetLoclist(buffer) *ale#engine#GetLoclist()* + + Given a buffer number, this function will rerurn the list of warnings and + errors reported by ALE for a given buffer in the format accepted by + |setqflist()|. + + ale#linter#Define(filetype, linter) *ale#linter#Define()* Given a |String| for a filetype and a |Dictionary| Describing a linter configuration, add a linter for the given filetype. The dictionaries each |