diff options
author | 2016-06-15 17:27:55 -0400 | |
---|---|---|
committer | 2016-06-15 17:27:55 -0400 | |
commit | 190f9aaeb206bfe209291898fae17880d5f62748 (patch) | |
tree | 3ce9c580c2445d97615c418218dac43cb963786d /core/events.lua | |
parent | 27c42565b3b1cccf0c2eb5770614b67617de6b48 (diff) | |
download | textadept-190f9aaeb206bfe209291898fae17880d5f62748.tar.gz textadept-190f9aaeb206bfe209291898fae17880d5f62748.zip |
Lots of small LuaDoc improvements (grammar mainly).
Diffstat (limited to 'core/events.lua')
-rw-r--r-- | core/events.lua | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/core/events.lua b/core/events.lua index 2173ea4b..0569b09a 100644 --- a/core/events.lua +++ b/core/events.lua @@ -6,8 +6,6 @@ local M = {} --- -- Textadept's core event structure and handlers. -- --- ## Overview --- -- Textadept emits events when you do things like create a new buffer, press a -- key, click on a menu, etc. You can even emit events yourself using Lua. Each -- event has a set of event handlers, which are simply Lua functions called in @@ -119,7 +117,7 @@ local M = {} -- -- * _`text`_: The error message text. -- @field FIND (string) --- Emitted to find text via the Find & Replace Pane. +-- Emitted in order to find text via the Find & Replace Pane. -- Arguments: -- -- * _`text`_: The text to search for. @@ -170,7 +168,8 @@ local M = {} -- Emitted after selecting a menu item. -- Arguments: -- --- * _`menu_id`_: The numeric ID of the menu item set in [`ui.menu()`](). +-- * _`menu_id`_: The numeric ID of the menu item, which was defined in +-- [`ui.menu()`](). -- @field MOUSE (string) -- Emitted by the terminal version for an unhandled mouse event. -- Arguments: @@ -192,7 +191,7 @@ local M = {} -- procedure. -- Emitted by [`quit()`](). -- @field REPLACE (string) --- Emitted to replace selected (found) text. +-- Emitted in order to replace selected (found) text. -- Arguments: -- -- * _`text`_: The replacement text. |