diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2025-03-05 00:40:00 -0500 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2025-03-05 00:40:00 -0500 |
| commit | 9a3162633d358c9dc698b2733027981203514dc9 (patch) | |
| tree | 38f6ebd8121f5dab2f04173dda8b9cefd2de1fdf /docs/README.md | |
| parent | dba2d62d15d8233c189a109f97d7cda70fa7f6b7 (diff) | |
Shorten API docs
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 24 |
1 files changed, 0 insertions, 24 deletions
diff --git a/docs/README.md b/docs/README.md index 2704eee6..8d7e6d02 100644 --- a/docs/README.md +++ b/docs/README.md @@ -39,8 +39,6 @@ Information about Tomo's built-in types can be found here: ## Built-in Functions ### `ask` - -**Description:** Gets a line of user input text with a prompt. **Signature:** @@ -48,8 +46,6 @@ Gets a line of user input text with a prompt. func ask(prompt:Text, bold:Bool = yes, force_tty:Bool = yes -> Void) ``` -**Parameters:** - - `prompt`: The text to print as a prompt before getting the input. - `bold`: Whether or not to print make the prompt appear bold on a console using the ANSI escape sequence `\x1b[1m`. @@ -74,8 +70,6 @@ something went wrong (e.g. the user hit `Ctrl-D`). --- ### `exit` - -**Description:** Exits the program with a given status and optionally prints a message. **Signature:** @@ -83,8 +77,6 @@ Exits the program with a given status and optionally prints a message. func ask(message:Text? = !Text, status:Int32 = 1[32] -> 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 (default: 1, which @@ -101,8 +93,6 @@ exit(status=1, "Goodbye forever!") --- ### `say` - -**Description:** Prints a message to the console. **Signature:** @@ -110,8 +100,6 @@ Prints a message to the console. func say(text:Text, newline:Bool = yes -> Void) ``` -**Parameters:** - - `text`: The text to print. - `newline`: Whether or not to print a newline after the text. @@ -127,8 +115,6 @@ say("world!") --- ### `sleep` - -**Description:** Pause execution for a given number of seconds. **Signature:** @@ -136,8 +122,6 @@ Pause execution for a given number of seconds. func sleep(seconds: Num -> Void) ``` -**Parameters:** - - `seconds`: How many seconds to sleep for. **Returns:** @@ -151,8 +135,6 @@ sleep(1.5) --- ### `fail` - -**Description:** Prints a message to the console, aborts the program, and prints a stack trace. **Signature:** @@ -160,8 +142,6 @@ Prints a message to the console, aborts the program, and prints a stack trace. func fail(message:Text -> Abort) ``` -**Parameters:** - - `message`: The error message to print. **Returns:** @@ -175,8 +155,6 @@ fail("Oh no!") --- ### `now` - -**Description:** Gets the current time. This is an alias for `Moment.now()`. **Signature:** @@ -184,8 +162,6 @@ Gets the current time. This is an alias for `Moment.now()`. func now(->Moment) ``` -**Parameters:** - None. **Returns:** |
