From 7464702052faaf9d6ea969315dc8b658a3c41b0c Mon Sep 17 00:00:00 2001
From: sammyette <torchedsammy@gmail.com>
Date: Sat, 27 Apr 2024 20:31:17 -0400
Subject: [PATCH] docs(hilbish.run): detail streams parameter

---
 api.go | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/api.go b/api.go
index 69e1f7a..9842f93 100644
--- a/api.go
+++ b/api.go
@@ -186,7 +186,12 @@ func handleStream(v rt.Value, strms *streams, errStream bool) error {
 // run(cmd, streams) -> exitCode (number), stdout (string), stderr (string)
 // Runs `cmd` in Hilbish's shell script interpreter.
 // #param cmd string
-// #param returnOut boolean If this is true, the function will return the standard output and error of the command instead of printing it.
+// #param streams table|boolean
+// Specifies the output and input streams the command should use.
+// For example, to write command output to a sink.
+// As a table, the caller can directly specify the standard output, error, and input
+// streams of the command with the table keys `out`, `err`, and `input` respectively.
+// As a boolean, it specifies whether the command should use standard output or return its output streams.
 // #returns number, string, string
 func hlrun(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	// TODO: ON BREAKING RELEASE, DO NOT ACCEPT `streams` AS A BOOLEAN.