diff options
author | mitchell <70453897+667e-11@users.noreply.github.com> | 2014-06-04 22:23:33 -0400 |
---|---|---|
committer | mitchell <70453897+667e-11@users.noreply.github.com> | 2014-06-04 22:23:33 -0400 |
commit | 85ded42e3bc65cc3c233ca9b96f28e85b988e56f (patch) | |
tree | c02b113edcab517da8ecdf4ffe5a44ed0aa25086 | |
parent | 5c12a6ae46f93fdb22cd779089bec57f809a2600 (diff) |
Updated spawn LuaDoc; core/init.lua
-rw-r--r-- | core/init.lua | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/core/init.lua b/core/init.lua index 42e6f250..236b5eb6 100644 --- a/core/init.lua +++ b/core/init.lua @@ -154,20 +154,20 @@ local timeout -- The terminal version spawns processes in the same thread. -- @param argv A command line string containing the program's name followed by -- arguments to pass to it. `PATH` is searched for program names. --- @param working_dir The child's current working directory (cwd) or `nil` to --- inherit the parent's. --- @param stdout_cb A Lua function that accepts a string parameter for a block --- of standard output read from the child. Stdout is read asynchronously in --- 1KB or 0.5KB blocks (depending on the platform), or however much data is +-- @param working_dir Optional current working directory (cwd) for the child +-- process. The default value is `nil`, which inherits the parent's cwd. +-- @param stdout_cb Optional Lua function that accepts a string parameter for a +-- block of standard output read from the child. Stdout is read asynchronously +-- in 1KB or 0.5KB blocks (depending on the platform), or however much data is -- available at the time. -- The terminal version sends all output, whether it be stdout or stderr, to -- this callback after the process finishes. --- @param stderr_cb A Lua function that accepts a string parameter for a block --- of standard error read from the child. Stderr is read asynchronously in 1KB --- or 0.5kB blocks (depending on the platform), or however much data is +-- @param stderr_cb Optional Lua function that accepts a string parameter for a +-- block of standard error read from the child. Stderr is read asynchronously +-- in 1KB or 0.5kB blocks (depending on the platform), or however much data is -- available at the time. --- @param exit_cb A Lua function that is called when the child process finishes. --- The child's exit status is passed. +-- @param exit_cb Optional Lua function that is called when the child process +-- finishes. The child's exit status is passed. -- @return proc -- @usage spawn('lua buffer.filename', nil, print) -- @usage proc = spawn('lua -e "print(io.read())", nil, print) |