From 67e8f2dea0d4eec20a839d47f1fa6302a4a5f733 Mon Sep 17 00:00:00 2001 From: Bruce Hill Date: Mon, 19 Aug 2024 00:23:02 -0400 Subject: Move docs into one folder --- api/README.md | 68 ----------------------------------------------------------- 1 file changed, 68 deletions(-) delete mode 100644 api/README.md (limited to 'api/README.md') diff --git a/api/README.md b/api/README.md deleted file mode 100644 index a7fe1262..00000000 --- a/api/README.md +++ /dev/null @@ -1,68 +0,0 @@ -# API - -Tomo has a small number of built-in functions and bunch of types. - -## Types - -- [Arrays](arrays.md) -- [Booleans](booleans.md) -- [Channels](channels.md) -- [Enums](enums.md) -- [Floating point numbers](nums.md) -- [Integer Ranges](ranges.md) -- [Integers](integers.md) -- [Sets](sets.md) -- [Structs](structs.md) -- [Tables](tables.md) -- [Text](text.md) -- [Threads](threads.md) - -## Built-in Functions - -### `say` - -**Description:** -Prints a message to the console. - -**Usage:** -```markdown -say(text:Text) -> Void -``` - -**Parameters:** - -- `text`: The text to print. - -**Returns:** -Nothing. - -**Example:** -```markdown -say("Hello world!") -``` - ---- - -### `fail` - -**Description:** -Prints a message to the console, aborts the program, and prints a stack trace. - -**Usage:** -```markdown -fail(message:Text) -> Abort -``` - -**Parameters:** - -- `message`: The error message to print. - -**Returns:** -Nothing, aborts the program. - -**Example:** -```markdown -fail("Oh no!") -``` - ---- -- cgit v1.2.3