commit 4ea4d72af800c40511afd006ea202d008e653c3f
parent 0c86828ac57429e3dea1bb4a9e686dc4f0dc9ddb
Author: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 2 Sep 2023 16:38:58 +0200
docs(luv): correct uv.spawn options.args docs about the first argument
https://github.com/luvit/luv/commit/045bf29b6f54f9b511f8b76088250d2a90dbdf4f
Diffstat:
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/runtime/doc/luvref.txt b/runtime/doc/luvref.txt
@@ -1301,11 +1301,11 @@ uv.spawn({path}, {options}, {on_exit}) *uv.spawn()*
The `options` table accepts the following fields:
- `options.args` - Command line arguments as a list of
- string. The first string should be the path to the
- program. On Windows, this uses CreateProcess which
- concatenates the arguments into a string. This can cause
- some strange errors. (See `options.verbatim` below for
- Windows.)
+ strings. The first string should not be the path to the
+ program, since that is already provided via `path`. On
+ Windows, this uses CreateProcess which concatenates the
+ arguments into a string. This can cause some strange
+ errors (see `options.verbatim` below for Windows).
- `options.stdio` - Set the file descriptors that will be
made available to the child process. The convention is
that the first entries are stdin, stdout, and stderr.