From 69d38d704844de95302fe1fc7cdeea9fed9e4162 Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Mon, 4 Apr 2022 10:40:25 +0000 Subject: [PATCH] docs: [ci] generate new docs --- docs/hilbish.txt | 4 +++- docs/terminal.txt | 4 ++-- emmyLuaDocs/hilbish.lua | 4 +++- emmyLuaDocs/terminal.lua | 6 +++--- 4 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/hilbish.txt b/docs/hilbish.txt index d843b40..6244240 100644 --- a/docs/hilbish.txt +++ b/docs/hilbish.txt @@ -45,7 +45,9 @@ read(prompt) -> input? > Read input from the user, using Hilbish's line editor/i This is a separate instance from the one Hilbish actually uses. Returns `input`, will be nil if ctrl + d is pressed, or an error occurs (which shouldn't happen) -run(cmd) > Runs `cmd` in Hilbish's sh interpreter. +run(cmd, returnOut) -> exitCode, stdout, stderr > Runs `cmd` in Hilbish's sh interpreter. +If returnOut is true, the outputs of `cmd` will be returned as the 2nd and +3rd values instead of being outputted to the terminal. runnerMode(mode) > Sets the execution/runner mode for interactive Hilbish. This determines whether Hilbish wll try to run input as Lua and/or sh or only do one of either. diff --git a/docs/terminal.txt b/docs/terminal.txt index 80af3f4..7683bbb 100644 --- a/docs/terminal.txt +++ b/docs/terminal.txt @@ -1,9 +1,9 @@ -setRaw() > Puts the terminal in raw mode - restoreState() > Restores the last saved state of the terminal saveState() > Saves the current state of the terminal +setRaw() > Puts the terminal in raw mode + size() > Gets the dimensions of the terminal. Returns a table with `width` and `height` Note: this is not the size in relation to the dimensions of the display diff --git a/emmyLuaDocs/hilbish.lua b/emmyLuaDocs/hilbish.lua index 9b0c263..934df3d 100644 --- a/emmyLuaDocs/hilbish.lua +++ b/emmyLuaDocs/hilbish.lua @@ -58,7 +58,7 @@ function hilbish.interval(cb, time) end --- Changes the continued line prompt to `str` --- @param str string -function hilbish.mlprompt(str) end +function hilbish.multiprompt(str) end --- Prepends `dir` to $PATH --- @param dir string @@ -80,6 +80,8 @@ function hilbish.prompt(str) end function hilbish.read(prompt) end --- Runs `cmd` in Hilbish's sh interpreter. +--- If returnOut is true, the outputs of `cmd` will be returned as the 2nd and +--- 3rd values instead of being outputted to the terminal. --- @param cmd string function hilbish.run(cmd) end diff --git a/emmyLuaDocs/terminal.lua b/emmyLuaDocs/terminal.lua index 57073ae..2266ac6 100644 --- a/emmyLuaDocs/terminal.lua +++ b/emmyLuaDocs/terminal.lua @@ -2,15 +2,15 @@ local terminal = {} ---- Puts the terminal in raw mode -function terminal.raw() end - --- Restores the last saved state of the terminal function terminal.restoreState() end --- Saves the current state of the terminal function terminal.saveState() end +--- Puts the terminal in raw mode +function terminal.setRaw() end + --- Gets the dimensions of the terminal. Returns a table with `width` and `height` --- Note: this is not the size in relation to the dimensions of the display function terminal.size() end