From 5f98f4e9afdc411dd492d103ff7e26c258d9b935 Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Mon, 19 Nov 2012 23:53:30 -0500
Subject: Rewrote LuaDoc.

---
 modules/lua/init.lua | 18 ++++++++----------
 1 file changed, 8 insertions(+), 10 deletions(-)

(limited to 'modules/lua/init.lua')

diff --git a/modules/lua/init.lua b/modules/lua/init.lua
index 5ea32fd2..b9a2ed80 100644
--- a/modules/lua/init.lua
+++ b/modules/lua/init.lua
@@ -11,15 +11,13 @@ local M = {}
 --
 -- + `Ctrl+L, M` (`⌘L, M` on Mac OSX | `M-L, M` in ncurses)
 --   Open this module for editing.
--- + `Shift+Enter` (`⇧↩` | `S-Enter`)
---   Try to autocomplete an `if`, `while`, `for`, etc. control structures with
---   `end`.
 -- + `.`
---   When to the right of a known symbol, show an autocompletion list of fields
---   and functions.
+--   Show an autocompletion list of fields for the symbol behind the caret.
 -- + `:`
---   When to the right of a known symbol, show an autocompletion list of
---   functions only.
+--   Show an autocompletion list of functions for the symbol behind the caret.
+-- + `Shift+Enter` (`⇧↩` | `S-Enter`)
+--   Autocomplete an `if`, `while`, `for`, etc. control structure with the `end`
+--   keyword.
 -- @field sense
 --   The Lua [Adeptsense](_M.textadept.adeptsense.html).
 --   It loads user tags from *`_USERHOME`/modules/lua/tags* and user apidocs
@@ -96,7 +94,7 @@ end
 -- Commands.
 
 ---
--- Patterns for auto `end` completion for control structures.
+-- List of patterns for auto-`end` completion for control structures.
 -- @class table
 -- @name control_structure_patterns
 -- @see try_to_autocomplete_end
@@ -106,8 +104,8 @@ local control_structure_patterns = {
 }
 
 ---
--- Tries to autocomplete Lua's `end` keyword for control structures like `if`,
--- `while`, `for`, etc.
+-- Tries to autocomplete control structures like `if`, `while`, `for`, etc. with
+-- the `end` keyword.
 -- @see control_structure_patterns
 -- @name try_to_autocomplete_end
 function M.try_to_autocomplete_end()
-- 
cgit v1.2.3