summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2022-03-01 13:48:16 +0000
committerw0rp <devw0rp@gmail.com>2022-03-01 13:48:16 +0000
commit3e1a98ff67b0dd17e36a08ab73d069f66fb5be24 (patch)
tree107c16de7f6d4622d73502c540815ffdccbb99bf /doc
parent7ac0f633cc864e6ff40e3af5fd2fa71fb5dd3966 (diff)
downloadale-3e1a98ff67b0dd17e36a08ab73d069f66fb5be24.zip
#3495 Mention that ShowResults() must not be called synchronously
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt6
1 files changed, 6 insertions, 0 deletions
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