From 098be412f70bb6722c6751b70f939f08f70e196d Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Wed, 9 Oct 2013 00:23:46 -0400
Subject: More LuaDoc updates.

---
 modules/textadept/adeptsense.lua | 11 ++++++-----
 modules/textadept/editing.lua    | 19 ++++++++-----------
 modules/textadept/find.lua       | 20 ++++++++++----------
 modules/textadept/run.lua        |  2 +-
 modules/textadept/session.lua    |  4 ++--
 5 files changed, 27 insertions(+), 29 deletions(-)

(limited to 'modules')

diff --git a/modules/textadept/adeptsense.lua b/modules/textadept/adeptsense.lua
index fc1431c9..90cd952e 100644
--- a/modules/textadept/adeptsense.lua
+++ b/modules/textadept/adeptsense.lua
@@ -112,11 +112,12 @@ local M = {}
 -- ### Completion Lists
 --
 -- Even though your Adeptsense now understands the basic syntax of your
--- programming language, it is not smart enough to parse code to generate lists
--- of function and field completions for classes. Instead, you must supply this
--- information to your Adeptsense's [`completions`](#completions) table. The
--- table contains string class names assigned to tables that themselves contain
--- `functions` and `fields` completion tables. Here is the general form:
+-- programming language, it is not smart enough to parse code in order to
+-- generate lists of function and field completions for classes. Instead, you
+-- must supply this information to your Adeptsense's
+-- [`completions`](#completions) table. The table contains string class names
+-- assigned to tables that themselves contain `functions` and `fields`
+-- completion tables. Here is the general form:
 --
 --     M.sense.completions = {
 --       ['class1'] = {
diff --git a/modules/textadept/editing.lua b/modules/textadept/editing.lua
index 877354a9..bb096b89 100644
--- a/modules/textadept/editing.lua
+++ b/modules/textadept/editing.lua
@@ -418,12 +418,9 @@ function M.select_paragraph()
 end
 
 ---
--- Selects indented text blocks intelligently.
--- If no block of text is selected, all text with the current level of
--- indentation is selected. If a block of text is selected and the lines
--- immediately above and below it are one indentation level lower, they are
--- added to the selection. In all other cases, the behavior is the same as if no
--- text is selected.
+-- Selects all text with the current level of indentation.
+-- If a text block is selected and the lines immediately above and below it are
+-- one indentation level lower, adds those lines to the selection.
 -- @name select_indented_block
 function M.select_indented_block()
   local buffer = buffer
@@ -505,15 +502,15 @@ function M.highlight_word()
 end
 
 ---
--- Passes selected or all buffer text to string shell command *command* as
--- standard input (stdin) and replaces the input text with the command's
+-- Passes the selected text or all buffer text to string shell command *command*
+-- as standard input (stdin) and replaces the input text with the command's
 -- standard output (stdout).
 -- Standard input is as follows:
 --
 -- 1. If text is selected and spans multiple lines, all text on the lines
--- containing the selection is used. However, if the end of the selection is at
--- the beginning of a line, only the EOL (end of line) characters from the
--- previous line are included as input. The rest of the line is excluded.
+-- containing the selection is passed as stdin. However, if the end of the
+-- selection is at the beginning of a line, only the line ending characters from
+-- the previous line are included. The rest of the line is excluded.
 -- 2. If text is selected and spans a single line, only the selected text is
 -- used.
 -- 3. If no text is selected, the entire buffer is used.
diff --git a/modules/textadept/find.lua b/modules/textadept/find.lua
index 177e85e8..4a9e6054 100644
--- a/modules/textadept/find.lua
+++ b/modules/textadept/find.lua
@@ -10,16 +10,16 @@ local M = ui.find
 -- @field replace_entry_text (string)
 --   The text in the replace entry.
 -- @field match_case (bool)
---   Searches are case-sensitive.
+--   Match the search text case sensitively.
 --   The default value is `false`.
 -- @field whole_word (bool)
---   Match only whole-words in searches.
+--   Match the search text surrounded by non-word characters in searches.
 --   The default value is `false`.
 -- @field lua (bool)
---   Interpret search text as a Lua pattern.
+--   Interpret the search text as a Lua pattern.
 --   The default value is `false`.
 -- @field in_files (bool)
---   Search for the text in a list of files.
+--   Find the search text in a list of files.
 --   The default value is `false`.
 -- @field find_label_text (string, Write-only)
 --   The text of the "Find" label.
@@ -80,11 +80,11 @@ local preferred_view
 ---
 -- The table of Lua patterns matching files and folders to exclude when finding
 -- in files.
--- Each filter string is a pattern that matches filenames to exclude, with
--- patterns matching folders to exclude listed in a `folders` sub-table.
--- Patterns starting with '!' exclude files and folders that do not match the
--- pattern that follows. Use a table of raw file extensions assigned to an
--- `extensions` key for fast filtering by extension.
+-- The filter contains Lua patterns that match filenames to exclude, an optional
+-- `folders` sub-table that contains patterns matching folders to exclude, and
+-- an optional `extensions` sub-table that contains raw file extensions to
+-- exclude. Any patterns starting with '!' exclude files and folders that do not
+-- match the pattern that follows.
 -- The default value is `lfs.FILTER`, a filter for common binary file extensions
 -- and version control folders.
 -- @see find_in_files
@@ -326,7 +326,7 @@ events.connect(events.REPLACE_ALL, replace_all)
 -- Returns whether or not the given buffer is a files found buffer.
 local function is_ff_buf(buf) return buf._type == _L['[Files Found Buffer]'] end
 ---
--- Goes to the source of the find in files search result on line number *line*
+-- Jumps to the source of the find in files search result on line number *line*
 -- in the files found buffer, or if `nil`, the next or previous search result
 -- depending on boolean *next*.
 -- @param line The line number in the files found buffer that contains the
diff --git a/modules/textadept/run.lua b/modules/textadept/run.lua
index d6f9f421..32823c47 100644
--- a/modules/textadept/run.lua
+++ b/modules/textadept/run.lua
@@ -187,7 +187,7 @@ M.error_patterns = {--[[ANTLR]]'^error%(%d+%): (.-):(%d+):%d+: (.+)$','^warning%
 -- Returns whether or not the given buffer is a message buffer.
 local function is_msg_buf(buf) return buf._type == _L['[Message Buffer]'] end
 ---
--- Goes to the source of the recognized compile/run warning or error on line
+-- Jumps to the source of the recognized compile/run warning or error on line
 -- number *line* in the message buffer or the next or previous recognized
 -- warning or error depending on boolean *next*.
 -- Displays an annotation with the warning or error message, if available.
diff --git a/modules/textadept/session.lua b/modules/textadept/session.lua
index 2419a822..d470ce5a 100644
--- a/modules/textadept/session.lua
+++ b/modules/textadept/session.lua
@@ -29,8 +29,8 @@ M.SAVE_ON_QUIT = true
 M.MAX_RECENT_FILES = 10
 
 ---
--- Loads Textadept session file *filename* or prompts the user to selectone,
--- returning `true` if the session file was opened and read.
+-- Loads Textadept session file *filename* or user-selected file, returning
+-- `true` if the session file was opened and read.
 -- Textadept restores split views, opened buffers, cursor information, and
 -- recent files.
 -- @param filename Optional absolute path to the session file to load. If `nil`,
-- 
cgit v1.2.3