aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index 3c4e3d62..03c90596 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -68,6 +68,32 @@ something went wrong (e.g. the user hit `Ctrl-D`).
---
+### `exit`
+
+**Description:**
+Exits the program with a given status and optionally prints a message.
+
+**Usage:**
+```markdown
+ask(message:Text = "", status:Int32 = 0_i32) -> Void
+```
+
+**Parameters:**
+
+- `message`: If nonempty, this message will be printed (with a newline) before
+ exiting.
+- `status`: The status code that the program with exit with.
+
+**Returns:**
+This function never returns.
+
+**Example:**
+```markdown
+exit(status=1, "Goodbye forever!")
+```
+
+---
+
### `say`
**Description:**