aboutsummaryrefslogtreecommitdiff
path: root/core/events.lua
diff options
context:
space:
mode:
Diffstat (limited to 'core/events.lua')
-rw-r--r--core/events.lua7
1 files changed, 5 insertions, 2 deletions
diff --git a/core/events.lua b/core/events.lua
index c63e98a8..afa851f9 100644
--- a/core/events.lua
+++ b/core/events.lua
@@ -206,8 +206,11 @@ local M = {}
-- * _`alt`_: The "Alt"/"Option" modifier key is held down.
-- @field QUIT (string)
-- Emitted when quitting Textadept.
--- When connecting to this event, connect with an index of 1 or the handler
--- will be ignored.
+-- When connecting to this event, connect with an index of 1 if the handler
+-- needs to run before Textadept closes all open buffers. If a handler returns
+-- `true`, Textadept does not quit. It is not recommended to return `false`
+-- from a quit handler, as that may interfere with Textadept's normal shutdown
+-- procedure.
-- Emitted by [`quit()`]().
-- @field REPLACE (string)
-- Emitted to replace selected (found) text.