Merge pull request #800 from blueyed/doc-fixes

Some minor doc/typo fixes
This commit is contained in:
Daniel Hahler 2016-04-04 20:37:13 +02:00
commit 6d550d478c
4 changed files with 21 additions and 18 deletions

View File

@ -390,7 +390,7 @@ for i = 1, 9 do
end end
end, end,
{description = "move focused client to tag #"..i, group = "tag"}), {description = "move focused client to tag #"..i, group = "tag"}),
-- Toggle tag. -- Toggle tag on focused client.
awful.key({ modkey, "Control", "Shift" }, "#" .. i + 9, awful.key({ modkey, "Control", "Shift" }, "#" .. i + 9,
function () function ()
if client.focus then if client.focus then

View File

@ -261,8 +261,9 @@ end
-- with command as argument when a command was changed. -- with command as argument when a command was changed.
-- @param[opt] keypressed_callback The callback function to call -- @param[opt] keypressed_callback The callback function to call
-- with mod table, key and command as arguments when a key was pressed. -- with mod table, key and command as arguments when a key was pressed.
function prompt.run(args, textbox, exe_callback, completion_callback,
function prompt.run(args, textbox, exe_callback, completion_callback, history_path, history_max, done_callback, changed_callback, keypressed_callback) history_path, history_max, done_callback,
changed_callback, keypressed_callback)
local grabber local grabber
local theme = beautiful.get() local theme = beautiful.get()
if not args then args = {} end if not args then args = {} end

View File

@ -129,20 +129,22 @@ function spawn.with_shell(cmd)
end end
end end
--- Spawn a program and asynchronously and capture its output line by line. --- Spawn a program and asynchronously capture its output line by line.
-- @tparam string|table cmd The command. -- @tparam string|table cmd The command.
-- @tab callbacks Table containing callbacks that should be -- @tab callbacks Table containing callbacks that should be invoked on
-- invoked on various conditions. -- various conditions.
-- @tparam[opt] function callbacks.stdout Function that is called with each line of -- @tparam[opt] function callbacks.stdout Function that is called with each
-- output on stdout, e.g. `stdout(line)`. -- line of output on stdout, e.g. `stdout(line)`.
-- @tparam[opt] function callbacks.stderr Function that is called with each line of -- @tparam[opt] function callbacks.stderr Function that is called with each
-- output on stderr, e.g. `stderr(line)`. -- line of output on stderr, e.g. `stderr(line)`.
-- @tparam[opt] function callbacks.output_done Function to call when no more output -- @tparam[opt] function callbacks.output_done Function to call when no more
-- is produced. -- output is produced.
-- @tparam[opt] function callbacks.exit Function to call when the spawned process -- @tparam[opt] function callbacks.exit Function to call when the spawned
-- exits. This function gets the exit reason and code as its argument. The -- process exits. This function gets the exit reason and code as its
-- reason can be "exit" or "signal". For "exit", the second argument is the exit -- arguments.
-- code. For "signal", the second argument is the signal causing process -- The reason can be "exit" or "signal".
-- For "exit", the second argument is the exit code.
-- For "signal", the second argument is the signal causing process
-- termination. -- termination.
-- @treturn[1] Integer the PID of the forked process. -- @treturn[1] Integer the PID of the forked process.
-- @treturn[2] string Error message. -- @treturn[2] string Error message.

View File

@ -113,7 +113,7 @@ keyboardlayout.xkeyboard_country_code = {
["za"] = true, -- South Africa ["za"] = true, -- South Africa
} }
-- Callback for updaing current layout -- Callback for updating current layout.
local function update_status (self) local function update_status (self)
self._current = awesome.xkb_get_layout_group(); self._current = awesome.xkb_get_layout_group();
local text = "" local text = ""