Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: fix awful.completion.shell (#1866)

This commit is contained in:
Daniel Hahler 2017-06-26 20:40:56 +02:00 committed by GitHub
parent 731099ba4d
commit 9cd26cd274
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/awful/completion.lua
View File

@ -54,12 +54,15 @@ local function bash_escape(str)
return str return str
end end
--- Use shell completion system to complete command and filename. --- Use shell completion system to complete commands and filenames.
-- @param command The command line. -- @tparam string command The command line.
-- @param cur_pos The cursor position. -- @tparam number cur_pos The cursor position.
-- @param ncomp The element number to complete. -- @tparam number ncomp The element number to complete.
-- @param shell The shell to use for completion (bash (default) or zsh). -- @tparam[opt=based on SHELL] string shell The shell to use for completion.
-- @return The new command, the new cursor position, the table of all matches. -- Supports "bash" and "zsh".
-- @treturn string The new command.
-- @treturn number The new cursor position.
-- @treturn table The table with all matches.
function completion.shell(command, cur_pos, ncomp, shell) function completion.shell(command, cur_pos, ncomp, shell)
local wstart = 1 local wstart = 1
local wend = 1 local wend = 1