From d98584ce68fb746b3a768ef8b476115c3bcaaa80 Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Sun, 31 Dec 2017 21:12:38 -0500 Subject: Updated LuaDoc. --- core/.buffer.luadoc | 7 +++++-- modules/textadept/editing.lua | 4 ++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc index a028beb9..2e94b37c 100644 --- a/core/.buffer.luadoc +++ b/core/.buffer.luadoc @@ -852,7 +852,8 @@ -- * `buffer.VS_NOWRAPLINESTART` -- Prevent the caret from wrapping to the previous line via -- `buffer:char_left()` and `buffer:char_left_extend()`. This option is not --- restricted to virtual space. +-- restricted to virtual space and should be added to any of the above +-- options. -- -- When virtual space is enabled, the caret may move into the space past end -- of line characters. @@ -3119,7 +3120,9 @@ function set_lexer(buffer, lexer) end -- User themes override Textadept's default themes when they have the same name. -- If *name* contains slashes, it is assumed to be an absolute path to a theme -- instead of a theme name. --- Note: this function must be called on startup in order to be effective. +-- Note: this function must be called on startup in order to be effective. Once +-- set, it applies to all subsequent buffers, so additional calls are +-- unnecessary. -- @param name The name or absolute path of a theme to set. -- @param props Optional table of theme property assignments that override the -- theme's defaults. diff --git a/modules/textadept/editing.lua b/modules/textadept/editing.lua index 193bf78a..deefe02f 100644 --- a/modules/textadept/editing.lua +++ b/modules/textadept/editing.lua @@ -555,7 +555,7 @@ end --- -- 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 output (stdout). *command* may contain pipes. -- Standard input is as follows: -- -- 1. If text is selected and spans multiple lines, all text on the lines that @@ -566,7 +566,7 @@ end -- used. -- 3. If no text is selected, the entire buffer is used. -- @param command The Linux, BSD, Mac OSX, or Windows shell command to filter --- text through. +-- text through. May contain pipes. -- @name filter_through function M.filter_through(command) local s, e = buffer.selection_start, buffer.selection_end -- cgit v1.2.3