aboutsummaryrefslogtreecommitdiff
path: root/docs/shell.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-03-05 00:40:00 -0500
committerBruce Hill <bruce@bruce-hill.com>2025-03-05 00:40:00 -0500
commit9a3162633d358c9dc698b2733027981203514dc9 (patch)
tree38f6ebd8121f5dab2f04173dda8b9cefd2de1fdf /docs/shell.md
parentdba2d62d15d8233c189a109f97d7cda70fa7f6b7 (diff)
Shorten API docs
Diffstat (limited to 'docs/shell.md')
-rw-r--r--docs/shell.md16
1 files changed, 0 insertions, 16 deletions
diff --git a/docs/shell.md b/docs/shell.md
index 5f65c9e1..06d74330 100644
--- a/docs/shell.md
+++ b/docs/shell.md
@@ -19,8 +19,6 @@ user-controlled string is automatically escaped when performing interpolation.
- [`func run(command: Shell -> [Byte]?)`](#run_bytes)
### `by_line`
-
-**Description:**
Run a shell command and return an iterator over its output, line-by-line.
**Signature:**
@@ -28,8 +26,6 @@ Run a shell command and return an iterator over its output, line-by-line.
func by_line(command: Shell -> Void)
```
-**Parameters:**
-
- `command`: The command to run.
**Returns:**
@@ -45,8 +41,6 @@ for line in $Shell"ping www.example.com":by_line()!:
```
### `execute`
-
-**Description:**
Execute a shell command without capturing its output and return its exit status.
**Signature:**
@@ -54,8 +48,6 @@ Execute a shell command without capturing its output and return its exit status.
func execute(command: Shell -> Int32?)
```
-**Parameters:**
-
- `command`: The command to execute.
**Returns:**
@@ -70,8 +62,6 @@ If the command exits normally, return its exit status. Otherwise return `none`.
---
### `run`
-
-**Description:**
Run a shell command and return the output text from `stdout`.
**Signature:**
@@ -79,8 +69,6 @@ Run a shell command and return the output text from `stdout`.
func run(command: Shell -> Text?)
```
-**Parameters:**
-
- `command`: The command to run.
**Returns:**
@@ -97,8 +85,6 @@ if there is a trailing newline, it will be stripped.
---
### `run_bytes`
-
-**Description:**
Run a shell command and return the output in raw bytes from `stdout`.
**Signature:**
@@ -106,8 +92,6 @@ Run a shell command and return the output in raw bytes from `stdout`.
func run(command: Shell -> [Byte]?)
```
-**Parameters:**
-
- `command`: The command to run.
**Returns:**