diff options
Diffstat (limited to 'modules/textadept')
| -rw-r--r-- | modules/textadept/editing.lua | 8 | ||||
| -rw-r--r-- | modules/textadept/find.lua | 4 | ||||
| -rw-r--r-- | modules/textadept/keys.lua | 3 | ||||
| -rw-r--r-- | modules/textadept/run.lua | 19 | ||||
| -rw-r--r-- | modules/textadept/session.lua | 7 | ||||
| -rw-r--r-- | modules/textadept/snippets.lua | 4 |
6 files changed, 24 insertions, 21 deletions
diff --git a/modules/textadept/editing.lua b/modules/textadept/editing.lua index cd8be1ba..dddbf98a 100644 --- a/modules/textadept/editing.lua +++ b/modules/textadept/editing.lua @@ -84,8 +84,8 @@ M.auto_pairs = {[40] = ')', [91] = ']', [123] = '}', [39] = "'", [34] = '"'} -- values. The default brace characters are '(', ')', '[', ']', '{', and '}'. -- @class table -- @name brace_matches --- @usage textadept.editing.brace_matches[60] = 1 -- '<' --- @usage textadept.editing.brace_matches[62] = 1 -- '>' +-- @usage textadept.editing.brace_matches[60] = true -- '<' +-- @usage textadept.editing.brace_matches[62] = true -- '>' M.brace_matches = {[40] = 1, [41] = 1, [91] = 1, [93] = 1, [123] = 1, [125] = 1} --- @@ -94,7 +94,7 @@ M.brace_matches = {[40] = 1, [41] = 1, [91] = 1, [93] = 1, [123] = 1, [125] = 1} -- The default characters are ')', ']', '}', ''', and '"'. -- @class table -- @name typeover_chars --- @usage textadept.editing.typeover_chars[62] = 1 -- '>' +-- @usage textadept.editing.typeover_chars[62] = true -- '>' M.typeover_chars = {[41] = 1, [93] = 1, [125] = 1, [39] = 1, [34] = 1} --- @@ -113,7 +113,7 @@ M.autocompleters = {} --- -- Map of lexer names to API documentation file tables. -- Each line in an API file consists of a symbol name (not a fully qualified --- symbol name), a space character, and that symbol's documentation. '\n' +-- symbol name), a space character, and that symbol's documentation. "\n" -- represents a newline character. -- @class table -- @name api_files diff --git a/modules/textadept/find.lua b/modules/textadept/find.lua index 561cae5b..366e4774 100644 --- a/modules/textadept/find.lua +++ b/modules/textadept/find.lua @@ -223,8 +223,8 @@ end -- *anchor* indicates whether or not to search for *text* starting from the -- caret position instead of the position where the incremental search began. -- Only the `match_case` find option is recognized. Normal command entry --- functionality is unavailable until the search is finished by pressing `Esc` --- (`⎋` on Mac OSX | `Esc` in curses). +-- functionality is unavailable until the search is finished or by pressing +-- `Esc` (`⎋` on Mac OSX | `Esc` in curses). -- @param text The text to incrementally search for, or `nil` to begin an -- incremental search. -- @param next Flag indicating whether or not the search direction is forward. diff --git a/modules/textadept/keys.lua b/modules/textadept/keys.lua index c95673c4..1a810969 100644 --- a/modules/textadept/keys.lua +++ b/modules/textadept/keys.lua @@ -5,7 +5,8 @@ local M = {} --[[ This comment is for LuaDoc. --- -- Defines key commands for Textadept. --- This set of key commands is pretty standard among other text editors. +-- This set of key commands is pretty standard among other text editors, at +-- least for basic editing commands and movements. -- -- ## Key Bindings -- diff --git a/modules/textadept/run.lua b/modules/textadept/run.lua index 7aa9c61a..f663eb0f 100644 --- a/modules/textadept/run.lua +++ b/modules/textadept/run.lua @@ -19,8 +19,9 @@ local M = {} -- The run or compile error marker number. -- @field _G.events.COMPILE_OUTPUT (string) -- Emitted when executing a language's compile shell command. --- By default, compiler output is printed to the message buffer. To override --- this behavior, connect to the event with an index of `1` and return `true`. +-- By default, compiler output is printed to the message buffer. In order to +-- override this behavior, connect to the event with an index of `1` and +-- return `true`. -- Arguments: -- -- * `output`: A line of string output from the command. @@ -28,8 +29,8 @@ local M = {} -- executed compile command. -- @field _G.events.RUN_OUTPUT (string) -- Emitted when executing a language's run shell command. --- By default, output is printed to the message buffer. To override this --- behavior, connect to the event with an index of `1` and return `true`. +-- By default, output is printed to the message buffer. In order to override +-- this behavior, connect to the event with an index of `1` and return `true`. -- Arguments: -- -- * `output`: A line of string output from the command. @@ -37,8 +38,8 @@ local M = {} -- executed run command. -- @field _G.events.BUILD_OUTPUT (string) -- Emitted when executing a project's build shell command. --- By default, output is printed to the message buffer. To override this --- behavior, connect to the event with an index of `1` and return `true`. +-- By default, output is printed to the message buffer. In order to override +-- this behavior, connect to the event with an index of `1` and return `true`. -- Arguments: -- -- * `output`: A line of string output from the command. @@ -316,9 +317,9 @@ end) -- patterns that match warning and error messages emitted by compile and run -- commands for those file extensions and lexers. -- Patterns match single lines and contain captures for a filename, line number, --- column number (optional), and warning or error message (optional). When a --- warning or error message is double-clicked, the user is taken to the source --- of that warning/error. +-- column number (optional), and warning or error message (optional). +-- Double-clicking a warning or error message takes the user to the source of +-- that warning/error. -- Note: `(.-)` captures in patterns are interpreted as filenames; `(%d+)` -- captures are interpreted as line numbers first, and then column numbers; and -- any other capture is treated as warning/error message text. diff --git a/modules/textadept/session.lua b/modules/textadept/session.lua index f0dea31c..e497aad0 100644 --- a/modules/textadept/session.lua +++ b/modules/textadept/session.lua @@ -27,8 +27,8 @@ M.max_recent_files = 10 --- -- Loads session file *filename* or the user-selected session, returning `true` -- if a session file was opened and read. --- Textadept restores split views, opened buffers, cursor information, and --- recent files. +-- Textadept restores split views, opened buffers, cursor information, recent +-- files, and bookmarks. -- @param filename Optional absolute path to the session file to load. If `nil`, -- the user is prompted for one. -- @return `true` if the session file was opened and read; `false` otherwise. @@ -110,7 +110,8 @@ end) --- -- Saves the session to file *filename* or the user-selected file. --- Saves split views, opened buffers, cursor information, and recent files. +-- Saves split views, opened buffers, cursor information, recent files, and +-- bookmarks. -- @param filename Optional absolute path to the session file to save. If `nil`, -- the user is prompted for one. -- @usage textadept.session.save(filename) diff --git a/modules/textadept/snippets.lua b/modules/textadept/snippets.lua index 2d4bc1de..ebb53505 100644 --- a/modules/textadept/snippets.lua +++ b/modules/textadept/snippets.lua @@ -75,7 +75,7 @@ local M = {} -- transform with the process' standard output (stdout). The code may use a `%` -- character to represent placeholder *n*'s text. An example is -- --- snippets['env'] = '$%1(HOME) = %1[echo $%1]' +-- snippets['env'] = '$%1(HOME) = %1[echo $%]' -- -- ### `%%` -- @@ -344,7 +344,7 @@ function M._cancel_current() end --- --- Prompts the user to select a snippet to be inserted from a list of global and +-- Prompts the user to select a snippet to insert from a list of global and -- language-specific snippets. -- @name _select function M._select() |