From d6b32bf2bd4a94a3fe7b70719a8f91061fd9a3f6 Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Sun, 26 May 2013 16:14:10 -0400 Subject: Rewrote some LuaDoc to use the active voice. --- modules/textadept/command_entry.lua | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) (limited to 'modules/textadept/command_entry.lua') diff --git a/modules/textadept/command_entry.lua b/modules/textadept/command_entry.lua index dab02e2b..45dd7d3c 100644 --- a/modules/textadept/command_entry.lua +++ b/modules/textadept/command_entry.lua @@ -12,9 +12,9 @@ local M = gui.command_entry -- The command entry supports multiple [modes][] that have their own sets of key -- bindings stored in a separate table in `_G.keys` under a mode prefix key. -- Mode names are arbitrary, but cannot conflict with lexer names or key --- sequence strings (e.g. `'lua'` or `'send'`) due to the method used for --- looking up key bindings. An example mode is "lua_command" mode for executing --- Lua commands: +-- sequence strings (e.g. `'lua'` or `'send'`) due to the method Textadept uses +-- for looking up key bindings. An example mode is "lua_command" mode for +-- executing Lua commands: -- -- local gui_ce = gui.command_entry -- keys['ce'] = {gui_ce.enter_mode, 'lua_command'} @@ -25,15 +25,10 @@ local M = gui.command_entry -- -- In this case, `Ctrl+E` opens the command entry and enters "lua_command" key -- mode where the `Tab` and `Enter` keys have special, defined functionality. --- (By default, `Esc` is pre-defined to exit any command entry mode.) `Tab` --- shows a list of Lua completions for the entry text and `Enter` exits --- "lua_command" key mode and executes the entered code. All other keys are --- handled normally by the command entry. --- --- It is important to note that while in any command entry key mode, all editor --- key bindings are ignored -- even if the editor, not the command entry, has --- focus. You must first exit the key mode by pressing `Esc` (or `Enter` in the --- case of the above "lua_command" key mode). +-- (By default, Textadept pre-defines `Esc` to exit any command entry mode.) +-- `Tab` shows a list of Lua completions for the entry text and `Enter` exits +-- "lua_command" key mode and executes the entered code. The command entry +-- handles all other keys normally. -- -- [modes]: keys.html#Modes -- @field entry_text (string) -- cgit v1.2.3