aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/filter_through.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-03-16 16:53:53 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2012-03-16 16:53:53 -0400
commitbdccda5d155578f6564bd7b13f1d1affd48b0671 (patch)
tree2f62fe3c2ce5c9d8cb7fe3125fd74360faedf248 /modules/textadept/filter_through.lua
parentc80a277bc7d220465ad46848b4dc805698e30895 (diff)
downloadtextadept-bdccda5d155578f6564bd7b13f1d1affd48b0671.tar.gz
textadept-bdccda5d155578f6564bd7b13f1d1affd48b0671.zip
Moved "Markdown:" comments into module LuaDoc comments.
Diffstat (limited to 'modules/textadept/filter_through.lua')
-rw-r--r--modules/textadept/filter_through.lua13
1 files changed, 8 insertions, 5 deletions
diff --git a/modules/textadept/filter_through.lua b/modules/textadept/filter_through.lua
index 3c43a131..0e6a0fc0 100644
--- a/modules/textadept/filter_through.lua
+++ b/modules/textadept/filter_through.lua
@@ -14,13 +14,16 @@ local filter_through_active = false
---
-- Prompts for a Linux, Mac OSX, or Windows shell command to filter text
-- through.
--- The standard input (stdin) for shell commands is determined as follows: (1)
--- If text is selected and spans multiple lines, all text on the lines
+-- The standard input (stdin) for shell commands is determined 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. (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.
+-- previous line are included as input. 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.
+--
-- The input text is replaced with the standard output (stdout) of the command.
-- @name filter_through
function M.filter_through()