From 2fb481c4cbe44ec0cc99b7d07a29dc48b95fe016 Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Sat, 26 Mar 2022 21:34:42 +0000 Subject: [PATCH] docs: [ci] generate new docs --- docs/hilbish.txt | 5 +++++ emmyLuaDocs/hilbish.lua | 7 +++++++ 2 files changed, 12 insertions(+) diff --git a/docs/hilbish.txt b/docs/hilbish.txt index 083d426..d405df9 100644 --- a/docs/hilbish.txt +++ b/docs/hilbish.txt @@ -16,6 +16,11 @@ exec(cmd) > Replaces running hilbish with `cmd` goro(fn) > Puts `fn` in a goroutine +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: +the current line and the position. It is expected to return a string +which will be used for the hint. + inputMode(mode) > Sets the input mode for Hilbish's line reader. Accepts either emacs for vim interval(cb, time) > Runs the `cb` function every `time` milliseconds diff --git a/emmyLuaDocs/hilbish.lua b/emmyLuaDocs/hilbish.lua index 90a2eb5..014c868 100644 --- a/emmyLuaDocs/hilbish.lua +++ b/emmyLuaDocs/hilbish.lua @@ -33,6 +33,13 @@ function hilbish.exec(cmd) end --- @param fn function function hilbish.goro(fn) end +--- 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: +--- the current line and the position. It is expected to return a string +--- which will be used for the hint. +--- @param cb function +function hilbish.hinter(cb) end + --- Sets the input mode for Hilbish's line reader. Accepts either emacs for vim --- @param mode string function hilbish.inputMode(mode) end