marc/ale
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Clean up the documentation some more, and make the description of the ALELint autocmd clearer

Browse source
This commit is contained in:
w0rp 2017-03-22 08:57:29 +00:00
parent 18bae7da2e
commit 59b5644fb3
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/ale.txt
View file

@ -1280,6 +1280,7 @@ ale#engine#ManageDirectory(buffer, directory) *ale#engine#ManageDirectory()*
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
offer the following options:
@ -1468,6 +1469,7 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
ale#linter#Get(filetype) *ale#linter#Get()*
Return all of linters configured for a given filetype as a |List| of
|Dictionary| values in the format specified by |ale#linter#Define()|.
@ -1481,6 +1483,7 @@ ale#linter#Get(filetype) *ale#linter#Get()*
ale#statusline#Status() *ale#statusline#Status()*
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: >
@ -1488,12 +1491,16 @@ ale#statusline#Status() *ale#statusline#Status()*
ALELint *ALELint-autocmd*
This |User| autocommand is triggered by ALE every time it completes a lint
operation. It can be used to update statuslines, send notifications, or
complete any other operation that needs to be done after a lint run.
It can be used simply:
autocmd User ALELint echom "ALE run!"
This |User| autocommand is triggered by ALE every time it completes a lint
cycle. It can be used to update statuslines, send notifications, or
complete any other operation that needs to be done after linting has been
performed.
For example, you can echo a message when linting is complete like so:
>
autocmd User ALELint echom "ALE run!"
<
===============================================================================
8. Special Thanks *ale-special-thanks*