aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/editing.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2013-09-13 23:06:56 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2013-09-13 23:06:56 -0400
commitbb7336a4dff7c68b65c50dce1818917c3416de0c (patch)
tree9b287e51f3eb8ad286ac1406f40f38b24db2e524 /modules/textadept/editing.lua
parentf37276331fe1e146193b45e380911b7a60e11de4 (diff)
downloadtextadept-bb7336a4dff7c68b65c50dce1818917c3416de0c.tar.gz
textadept-bb7336a4dff7c68b65c50dce1818917c3416de0c.zip
Updated some LuaDoc.
Diffstat (limited to 'modules/textadept/editing.lua')
-rw-r--r--modules/textadept/editing.lua14
1 files changed, 7 insertions, 7 deletions
diff --git a/modules/textadept/editing.lua b/modules/textadept/editing.lua
index 97935f13..143d07f5 100644
--- a/modules/textadept/editing.lua
+++ b/modules/textadept/editing.lua
@@ -25,7 +25,7 @@ local M = {}
-- Match the indentation level of the previous line when inserting a new line.
-- The default value is `true`.
-- @field STRIP_TRAILING_SPACES (bool)
--- Strip trailing whitespace on file save.
+-- Strip trailing whitespace before saving files.
-- The default value is `true`.
-- @field INDIC_HIGHLIGHT (number)
-- The word highlight indicator number.
@@ -202,24 +202,24 @@ function M.match_brace(select)
end
---
--- Displays an autocompletion list, built from the set of *default_words* and
--- existing words in the buffer, for the word behind the caret, returning `true`
--- if completions were found.
--- @param default_words Optional list of words considered to be in the buffer,
+-- Displays an autocompletion list, built from the set of string words *words*
+-- and existing words in the buffer, for the word behind the caret, returning
+-- `true` if completions were found.
+-- @param words Optional list of words considered to be in the buffer,
-- even if they are not. Words may contain [registered images][].
--
-- [registered images]: buffer.html#register_image
-- @return `true` if there were completions to show; `false` otherwise.
-- @see buffer.word_chars
-- @name autocomplete_word
-function M.autocomplete_word(default_words)
+function M.autocomplete_word(words)
local buffer = buffer
local pos, length = buffer.current_pos, buffer.length
local completions, c_list = {}, {}
local buffer_text = buffer:get_text()
local root = buffer_text:sub(1, pos):match('['..buffer.word_chars..']+$')
if not root or root == '' then return end
- for _, word in ipairs(default_words or {}) do
+ for _, word in ipairs(words or {}) do
if word:match('^'..root) then
c_list[#c_list + 1], completions[word:match('^(.-)%??%d*$')] = word, true
end