From 3e1a98ff67b0dd17e36a08ab73d069f66fb5be24 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 1 Mar 2022 13:48:16 +0000 Subject: [PATCH] #3495 Mention that ShowResults() must not be called synchronously --- doc/ale.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/ale.txt b/doc/ale.txt index 348cffaf..032e192e 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -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