1
0
mirror of https://github.com/janet-lang/janet synced 2024-11-28 11:09:54 +00:00

Fix function doc to match that of C POPEN

It may be misleading to some user to believe it is taking a path to a
file, when it is executing an arbitrary shell command for the first argument.
This commit is contained in:
Matthew Carter 2020-11-03 20:52:02 -05:00
parent f288bc1790
commit 4dffd662f0

View File

@ -777,7 +777,7 @@ static const JanetReg io_cfuns[] = {
#ifndef JANET_NO_PROCESSES #ifndef JANET_NO_PROCESSES
{ {
"file/popen", cfun_io_popen, "file/popen", cfun_io_popen,
JDOC("(file/popen path &opt mode)\n\n" JDOC("(file/popen command &opt mode)\n\n"
"Open a file that is backed by a process. The file must be opened in either " "Open a file that is backed by a process. The file must be opened in either "
"the :r (read) or the :w (write) mode. In :r mode, the stdout of the " "the :r (read) or the :w (write) mode. In :r mode, the stdout of the "
"process can be read from the file. In :w mode, the stdin of the process " "process can be read from the file. In :w mode, the stdin of the process "