From bc15da2f1a0773c8f5946ddfc09b72bf90206317 Mon Sep 17 00:00:00 2001 From: TorchedSammy <38820196+TorchedSammy@users.noreply.github.com> Date: Tue, 22 Mar 2022 18:38:13 -0400 Subject: [PATCH] docs: add more docs for runner mode interface --- docs/runner-mode.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/runner-mode.txt b/docs/runner-mode.txt index 69d0e17..41e0912 100644 --- a/docs/runner-mode.txt +++ b/docs/runner-mode.txt @@ -31,3 +31,10 @@ and also provides the sh and Lua runner functions that Hilbish itself uses. A runner function is expected to return 2 values: the exit code, and an error. The exit code has to be a number, it will be 0 otherwise and the error can be `nil` to indicate no error. + +## Functions +These are the functions for the `hilbish.runner` interface + ++ setMode(mode) > The same as `hilbish.runnerMode` ++ sh(input) -> code, err > Runs `input` in Hilbish's sh interpreter ++ lua(input) -> code, err > Evals `input` as Lua code