aboutsummaryrefslogtreecommitdiff
path: root/core/events.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2014-11-26 09:59:23 -0500
committermitchell <70453897+667e-11@users.noreply.github.com>2014-11-26 09:59:23 -0500
commitb21e66a3cd20e088149926ecdf5710dabd1ec03b (patch)
tree526ee6f2265f75740d258f77464d501a76b8ccbc /core/events.lua
parente8ef57a0f5401fe5469220a6f85a085100344f97 (diff)
downloadtextadept-b21e66a3cd20e088149926ecdf5710dabd1ec03b.tar.gz
textadept-b21e66a3cd20e088149926ecdf5710dabd1ec03b.zip
Allow connection to `events.QUIT` without requiring index of 1.
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.