sinks.in
| abs(path) -> string | -Returns an absolute version of the `path`. | +abs(path) -> string | +Returns an absolute version of the `path`. |
| basename(path) -> string | -Returns the "basename," or the last part of the provided `path`. If path is empty, | +basename(path) -> string | +Returns the "basename," or the last part of the provided `path`. If path is empty, |
| cd(dir) | -Changes Hilbish's directory to `dir`. | +cd(dir) | +Changes Hilbish's directory to `dir`. |
| dir(path) -> string | -Returns the directory part of `path`. If a file path like | +dir(path) -> string | +Returns the directory part of `path`. If a file path like |
| glob(pattern) -> matches (table) | -Match all files based on the provided `pattern`. | +glob(pattern) -> matches (table) | +Match all files based on the provided `pattern`. |
| join(...path) -> string | -Takes any list of paths and joins them based on the operating system's path separator. | +join(...path) -> string | +Takes any list of paths and joins them based on the operating system's path separator. |
| mkdir(name, recursive) | -Creates a new directory with the provided `name`. | +mkdir(name, recursive) | +Creates a new directory with the provided `name`. |
| fpipe() -> File, File | -Returns a pair of connected files, also known as a pipe. | +fpipe() -> File, File | +Returns a pair of connected files, also known as a pipe. |
| readdir(path) -> table[string] | -Returns a list of all files and directories in the provided path. | +readdir(path) -> table[string] | +Returns a list of all files and directories in the provided path. |
| stat(path) -> {} | -Returns the information about a given `path`. | +stat(path) -> {} | +Returns the information about a given `path`. |
| pathSep | -The operating system's path separator. | +pathSep | +The operating system's path separator. |
| alias(cmd, orig) | -Sets an alias, with a name of `cmd` to another command. | +alias(cmd, orig) | +Sets an alias, with a name of `cmd` to another command. |
| appendPath(dir) | -Appends the provided dir to the command path (`$PATH`) | +appendPath(dir) | +Appends the provided dir to the command path (`$PATH`) |
| complete(scope, cb) | -Registers a completion handler for the specified scope. | +complete(scope, cb) | +Registers a completion handler for the specified scope. |
| cwd() -> string | -Returns the current directory of the shell. | +cwd() -> string | +Returns the current directory of the shell. |
| exec(cmd) | -Replaces the currently running Hilbish instance with the supplied command. | +exec(cmd) | +Replaces the currently running Hilbish instance with the supplied command. |
| goro(fn) | -Puts `fn` in a Goroutine. | +goro(fn) | +Puts `fn` in a Goroutine. |
| highlighter(line) | -Line highlighter handler. | +highlighter(line) | +Line highlighter handler. |
| hinter(line, pos) | -The command line hint handler. It gets called on every key insert to | +hinter(line, pos) | +The command line hint handler. It gets called on every key insert to |
| inputMode(mode) | -Sets the input mode for Hilbish's line reader. | +inputMode(mode) | +Sets the input mode for Hilbish's line reader. |
| interval(cb, time) -> @Timer | -Runs the `cb` function every specified amount of `time`. | +interval(cb, time) -> @Timer | +Runs the `cb` function every specified amount of `time`. |
| multiprompt(str) | -Changes the text prompt when Hilbish asks for more input. | +multiprompt(str) | +Changes the text prompt when Hilbish asks for more input. |
| prependPath(dir) | -Prepends `dir` to $PATH. | +prependPath(dir) | +Prepends `dir` to $PATH. |
| prompt(str, typ) | -Changes the shell prompt to the provided string. | +prompt(str, typ) | +Changes the shell prompt to the provided string. |
| read(prompt) -> input (string) | -Read input from the user, using Hilbish's line editor/input reader. | +read(prompt) -> input (string) | +Read input from the user, using Hilbish's line editor/input reader. |
| timeout(cb, time) -> @Timer | -Executed the `cb` function after a period of `time`. | +timeout(cb, time) -> @Timer | +Executed the `cb` function after a period of `time`. |
| which(name) -> string | -Checks if `name` is a valid command. | +which(name) -> string | +Checks if `name` is a valid command. |
hilbish.editor
-new() -> @Readline
-Creates a new readline instance.
+new() -> @Readline
+Creates a new readline instance.
diff --git a/versions/new-website/docs/api/snail/index.html b/versions/new-website/docs/api/snail/index.html
index 01d404d5..6e83f7b8 100644
--- a/versions/new-website/docs/api/snail/index.html
+++ b/versions/new-website/docs/api/snail/index.html
@@ -5,8 +5,8 @@ Hilbish functions.new() -> @Snail
-Creates a new Snail instance.
+new() -> @Snail
+Creates a new Snail instance.
diff --git a/versions/new-website/docs/api/terminal/index.html b/versions/new-website/docs/api/terminal/index.html
index e26e839b..fd67b32f 100644
--- a/versions/new-website/docs/api/terminal/index.html
+++ b/versions/new-website/docs/api/terminal/index.html
@@ -3,20 +3,20 @@
-restoreState()
-Restores the last saved state of the terminal
+restoreState()
+Restores the last saved state of the terminal
-saveState()
-Saves the current state of the terminal.
+saveState()
+Saves the current state of the terminal.
-setRaw()
-Puts the terminal into raw mode.
+setRaw()
+Puts the terminal into raw mode.
-size()
-Gets the dimensions of the terminal. Returns a table with `width` and `height`
+size()
+Gets the dimensions of the terminal. Returns a table with `width` and `height`
diff --git a/versions/new-website/docs/api/yarn/index.html b/versions/new-website/docs/api/yarn/index.html
index 79a26f40..4f998ec0 100644
--- a/versions/new-website/docs/api/yarn/index.html
+++ b/versions/new-website/docs/api/yarn/index.html
@@ -10,8 +10,8 @@ t 'printing from another lua state!'
-thread(fun) -> @Thread
-Creates a new, fresh Yarn thread.
+thread(fun) -> @Thread
+Creates a new, fresh Yarn thread.