jshaver
/
ale
forked from github-mirrors/ale
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

#3495 Mention that ShowResults() must not be called synchronously

This commit is contained in:
w0rp 2022-03-01 13:48:16 +00:00
parent 7ac0f633cc
commit 3e1a98ff67
No known key found for this signature in database
GPG Key ID: 0FC1ECAA8C81CD83
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/ale.txt
View File

@ -287,6 +287,12 @@ number of the buffer that ALE wants to check.
sources should perform their checks on a buffer in the background
asynchronously, so they don't interrupt editing.
|ale#other_source#ShowResults()| must not be called synchronously before
ALE's engine executes its code after the |ALEWantResults| event runs. If
there are immediate results to provide to ALE, a 0 millisecond timer with
|timer_start()| can be set instead up to call |ale#other_source#ShowResults()|
after ALE has first executed its engine code for its own sources.
A plugin might integrate its own checks with ALE like so: >
augroup SomeGroupName