sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity

docs: [ci] generate new docs

pull/128/head
TorchedSammy 2022-03-26 22:28:27 +00:00 committed by GitHub Actions
parent 62a6cc56b9
commit 0aba60b5de
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/hilbish.txt
View File

@ -16,7 +16,11 @@ exec(cmd) > Replaces running hilbish with `cmd`
goro(fn) > Puts `fn` in a goroutine goro(fn) > Puts `fn` in a goroutine
> highlighter(cb) > Sets the highlighter function. This is mainly for syntax hightlighting, but in
reality could set the input of the prompt to display anything. The callback
is passed the current line as typed and is expected to return a line that will
be used to display in the line.
hinter(cb) > Sets the hinter function. This will be called on every key insert to determine hinter(cb) > Sets the hinter function. This will be called on every key insert to determine
what text to use as an inline hint. The callback is passed 2 arguments: what text to use as an inline hint. The callback is passed 2 arguments:
the current line and the position. It is expected to return a string the current line and the position. It is expected to return a string

8
emmyLuaDocs/hilbish.lua
View File

@ -33,8 +33,12 @@ function hilbish.exec(cmd) end
--- @param fn function --- @param fn function
function hilbish.goro(fn) end function hilbish.goro(fn) end
--- --- Sets the highlighter function. This is mainly for syntax hightlighting, but in
function hilbish.highlighter() end --- reality could set the input of the prompt to display anything. The callback
--- is passed the current line as typed and is expected to return a line that will
--- be used to display in the line.
--- @param cb function
function hilbish.highlighter(cb) end
--- Sets the hinter function. This will be called on every key insert to determine --- Sets the hinter function. This will be called on every key insert to determine
--- what text to use as an inline hint. The callback is passed 2 arguments: --- what text to use as an inline hint. The callback is passed 2 arguments: