Skip to content

Commit e62e51c

Browse files
committed
doc: Updates for ys::std IPC functions docs
1 parent 69a97ad commit e62e51c

1 file changed

Lines changed: 25 additions & 9 deletions

File tree

doc/ys-std.mdys

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -280,13 +280,24 @@ Security functions:
280280
sha256(S) X: Calculate the SHA-256 hash of a string
281281

282282
IPC functions:
283-
- exec(Cmd Str*) Result: Execute a command
284-
process(Cmd Str*) Result: Execute a command
285-
sh(Cmd Str*) Result: Execute a command
286-
shell(Cmd Str*) Result: Execute a command
287-
shout(Cmd Str*) Result: Execute a command and return the output
283+
- exec(Opts? Cmd Str*) Result: Execute a command
284+
process(Opts? Cmd Str*) Result: Execute a command
285+
sh(Opts? Cmd Str*) Result: Execute a command
286+
shell(Opts? Cmd Str*) Result: Execute a command
287+
sh-out(Opts? Cmd Str*) Result: Execute a command and return the output
288+
bash(Opts? Cmd Str*) Result: Command wrapped with `bash -c '...'`
289+
bash-out(Opts? Cmd Str*) Result: Run `bash` and return output
288290

289-
- https://github.com/babashka/process#readme
291+
- |
292+
Opts is an optional mapping that supports the following options:
293+
294+
* `:in` - stdin for command
295+
* `:out` - file to redirect stdout to
296+
* `:err` - file to redirect stderr to
297+
* `:dir` - working directory
298+
* `:env` - environment variables to use
299+
300+
- https://github.com/babashka/process/blob/master/API.md#babashka.process/process
290301

291302
External library functions:
292303
use-pod(pod-name version) nil: Load an external library pod
@@ -332,7 +343,12 @@ defn mdys-stdlib(o):
332343
fmt-fns: body
333344
body:string?: body
334345
else:
335-
str:
336-
fmt-fns(body.0)
337-
"\n**See also**:\ <$(body.1)>\n\n"
346+
if body.# == 3:
347+
str:
348+
fmt-fns(body.0)
349+
"\n$(body.1)"
350+
"\n**See also**:\ <$(body.2)>\n\n"
351+
str:
352+
fmt-fns(body.0)
353+
"\n**See also**:\ <$(body.1)>\n\n"
338354
```

0 commit comments

Comments
 (0)