From 4127396892e456f0733e5e12f7fcf6c0a9ba5b12 Mon Sep 17 00:00:00 2001 From: TorchedSammy <38820196+TorchedSammy@users.noreply.github.com> Date: Mon, 22 Nov 2021 22:04:30 -0500 Subject: [PATCH] docs: add docs for new functions --- docs/global.txt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/global.txt b/docs/global.txt index 6f1038e..62d628b 100644 --- a/docs/global.txt +++ b/docs/global.txt @@ -2,6 +2,12 @@ alias(cmd, orig) > Sets an alias of `orig` to `cmd` appendPath(dir) > Appends `dir` to $PATH +complete(scope, cb) > Registers a completion handler for `scope`. +A `scope` is currently only expected to be `command.`, +replacing with the name of the command (for example `command.git`). +`cb` must be a function that returns a table of the entries to complete. +Nested tables will be used as sub-completions. + exec(cmd) > Replaces running hilbish with `cmd` goro(fn) > Puts `fn` in a goroutine @@ -10,6 +16,8 @@ interval(cb, time) > Runs the `cb` function every `time` milliseconds multiprompt(str) > Changes the continued line prompt to `str` +prependPath(dir) > Prepends `dir` to $PATH + prompt(str) > Changes the shell prompt to `str` There are a few verbs that can be used in the prompt text. These will be formatted and replaced with the appropriate values.