From ea7517be052c26d527a017f08b469477008c6823 Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Tue, 12 Apr 2022 23:37:39 +0000 Subject: [PATCH] docs: [ci] generate new docs --- docs/hilbish.txt | 4 +++- emmyLuaDocs/hilbish.lua | 6 +++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/hilbish.txt b/docs/hilbish.txt index 6244240..4f13339 100644 --- a/docs/hilbish.txt +++ b/docs/hilbish.txt @@ -28,7 +28,8 @@ 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 +interval(cb, time) > Runs the `cb` function every `time` milliseconds. +Returns a `timer` object (see `doc timers`). multiprompt(str) > Changes the continued line prompt to `str` @@ -56,6 +57,7 @@ sh, and lua. It also accepts a function, to which if it is passed one will call it to execute user input instead. timeout(cb, time) > Runs the `cb` function after `time` in milliseconds +Returns a `timer` object (see `doc timers`). which(binName) > Searches for an executable called `binName` in the directories of $PATH diff --git a/emmyLuaDocs/hilbish.lua b/emmyLuaDocs/hilbish.lua index 934df3d..b49dc05 100644 --- a/emmyLuaDocs/hilbish.lua +++ b/emmyLuaDocs/hilbish.lua @@ -51,9 +51,11 @@ function hilbish.hinter(cb) end --- @param mode string function hilbish.inputMode(mode) end ---- Runs the `cb` function every `time` milliseconds +--- Runs the `cb` function every `time` milliseconds. +--- Returns a `timer` object (see `doc timers`). --- @param cb function --- @param time number +--- @return table function hilbish.interval(cb, time) end --- Changes the continued line prompt to `str` @@ -94,8 +96,10 @@ function hilbish.run(cmd) end function hilbish.runnerMode(mode) end --- Runs the `cb` function after `time` in milliseconds +--- Returns a `timer` object (see `doc timers`). --- @param cb function --- @param time number +--- @return table function hilbish.timeout(cb, time) end --- Searches for an executable called `binName` in the directories of $PATH