From 1c05dd067eeb8d876f9d3cf6374a7691682fc294 Mon Sep 17 00:00:00 2001
From: y5nw <37980625+y5nw@users.noreply.github.com>
Date: Fri, 22 Nov 2024 15:19:48 +0100
Subject: [PATCH] update AsyncJob:cancel documentation from review

---
 doc/lua_api.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/lua_api.md b/doc/lua_api.md
index 877f9e71f2..4ed1e55251 100644
--- a/doc/lua_api.md
+++ b/doc/lua_api.md
@@ -7999,6 +7999,7 @@ An `AsyncJob` is a reference to a job to be run in an async environment.
 ### Methods
 * `cancel()`: try to cancel the job
     * Returns whether the job was cancelled.
+    * A job can only be cancelled if it has not started.
 
 `InvRef`
 --------