diff options
| author | w0rp <devw0rp@gmail.com> | 2017-05-24 10:23:13 +0100 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2017-05-24 10:23:13 +0100 |
| commit | 92ade713f2c9c57bffa3b62550d2fbcd3f5d5d4a (patch) | |
| tree | ee6605446931d7c361f864bd168e815b308c81b1 /doc | |
| parent | 58880f33bed9d90ab42808aefdf7b8d9d962f20b (diff) | |
| download | ale-92ade713f2c9c57bffa3b62550d2fbcd3f5d5d4a.zip | |
#323 Document ale#statusline#Count() instead, and encourage its use
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale.txt | 26 |
1 files changed, 10 insertions, 16 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 207f5747..c8aa154f 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -646,17 +646,6 @@ g:ale_sign_warning *g:ale_sign_warning* The sign for warnings in the sign gutter. -g:ale_statusline_format *g:ale_statusline_format* - - Type: |List| - Default: `['%d error(s)', '%d warning(s)', 'OK']` - - This variable defines the format of |`ale#statusline#status()`| output. - - The 1st element is for errors - - The 2nd element is for warnings - - The 3rd element is for when no errors are detected - - g:ale_warn_about_trailing_whitespace *g:ale_warn_about_trailing_whitespace* b:ale_warn_about_trailing_whitespace *b:ale_warn_about_trailing_whitespace* @@ -1102,12 +1091,17 @@ ale#linter#Get(filetype) *ale#linter#Get()* components. -ale#statusline#Status() *ale#statusline#Status()* +ale#statusline#Count() *ale#statusline#Count()* + + Returns a |Dictionary| containing information about the number of problems + detected by ALE. The following keys are supported: - Return a formatted string that can be added to the statusline. - The output's format is defined in |`g:ale_statusline_format`|. - To enable it, the following should be present in your |statusline| settings: > - %{ale#statusline#Status()} + `error` -> The number of problems with type `E` and `sub_type != 'style'` + `warning` -> The number of problems with type `W` and `sub_type != 'style'` + `info` -> The number of problems with type `I` + `style_error` -> The number of problems with type `E` and `sub_type == 'style'` + `style_warning` -> The number of problems with type `W` and `sub_type == 'style'` + `total` -> The total number of problems. ALELint *ALELint-autocmd* |