Skip to content

Commit 7ca6834

Browse files
authored
improve Cmd.output! docs (#352)
1 parent 53dc8a3 commit 7ca6834

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

platform/Cmd.roc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,15 @@ clear_envs = |@Cmd(cmd)|
101101

102102
## Execute command and capture stdout and stderr
103103
##
104+
## Output is a record:
105+
## ```
106+
## {
107+
## status : Result I32 InternalIOErr.IOErr,
108+
## stdout : List U8,
109+
## stderr : List U8,
110+
## }
111+
## ```
112+
##
104113
## > Stdin is not inherited from the parent and any attempt by the child process
105114
## > to read from the stdin stream will result in the stream immediately closing.
106115
##

0 commit comments

Comments
 (0)