aboutsummaryrefslogtreecommitdiff
path: root/core/init.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2016-06-15 17:27:55 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2016-06-15 17:27:55 -0400
commit190f9aaeb206bfe209291898fae17880d5f62748 (patch)
tree3ce9c580c2445d97615c418218dac43cb963786d /core/init.lua
parent27c42565b3b1cccf0c2eb5770614b67617de6b48 (diff)
downloadtextadept-190f9aaeb206bfe209291898fae17880d5f62748.tar.gz
textadept-190f9aaeb206bfe209291898fae17880d5f62748.zip
Lots of small LuaDoc improvements (grammar mainly).
Diffstat (limited to 'core/init.lua')
-rw-r--r--core/init.lua8
1 files changed, 4 insertions, 4 deletions
diff --git a/core/init.lua b/core/init.lua
index 3b9f35cf..779dfab9 100644
--- a/core/init.lua
+++ b/core/init.lua
@@ -138,7 +138,7 @@ local quit
-- This function is useful for modifying user scripts (such as
-- *~/.textadept/init.lua* and *~/.textadept/modules/textadept/keys.lua*) on
-- the fly without having to restart Textadept. `arg` is set to `nil` when
--- reinitializing the Lua State. Any scripts that need to differentiate between
+-- reinitializing the Lua state. Any scripts that need to differentiate between
-- startup and reset can test `arg`.
-- @class function
-- @name reset
@@ -162,8 +162,8 @@ local timeout
-- a handle to that process.
-- At the moment, only the Win32 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 argv A command line string that contains the program's name followed
+-- by arguments to pass to it. `PATH` is searched for program names.
-- @param cwd Optional current working directory (cwd) for the child
-- process. The default value is `nil`, which inherits the parent's cwd.
-- @param env Optional list of environment variables for the child process.
@@ -206,7 +206,7 @@ function spawn_proc:wait() end
-- Similar to Lua's `io.read()` and blocks for input. *spawn_proc* must still be
-- running. If an error occurs while reading, returns `nil`, an error code, and
-- an error message.
--- Ensure any read operations read all stdout available. The stdout callback
+-- Ensure any read operations read all stdout available, as the stdout callback
-- function passed to `spawn()` will not be called until the stdout buffer is
-- clear.
-- @param arg Optional argument similar to those in Lua's `io.read()`, but "n"