From 99a121b6fa492936055e67810589238ddcfb7f51 Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Sun, 9 Jul 2023 20:49:25 +0000 Subject: [PATCH] docs: [ci] generate new docs --- docs/api/hilbish/_index.md | 5 ++++- docs/api/hilbish/hilbish.editor.md | 4 ++++ emmyLuaDocs/hilbish.lua | 10 +++++++++- 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/api/hilbish/_index.md b/docs/api/hilbish/_index.md index 8fb587a..bb00b14 100644 --- a/docs/api/hilbish/_index.md +++ b/docs/api/hilbish/_index.md @@ -125,7 +125,10 @@ A call with no argument will toggle the value. Flush writes all buffered input to the sink. #### read() -> string -Reads input from the sink. +Reads a liine of input from the sink. + +#### readAll() -> string +Reads all input from the sink. #### write(str) Writes data to a sink. diff --git a/docs/api/hilbish/hilbish.editor.md b/docs/api/hilbish/hilbish.editor.md index 30a3842..55c49ec 100644 --- a/docs/api/hilbish/hilbish.editor.md +++ b/docs/api/hilbish/hilbish.editor.md @@ -21,6 +21,10 @@ Returns the text that is at the register. ### insert(text) Inserts text into the line. +### getChar() -> string +Reads a keystroke from the user. This is in a format +of something like Ctrl-L. + ### setVimRegister(register, text) Sets the vim register at `register` to hold the passed text. diff --git a/emmyLuaDocs/hilbish.lua b/emmyLuaDocs/hilbish.lua index c26c7ec..50de52c 100644 --- a/emmyLuaDocs/hilbish.lua +++ b/emmyLuaDocs/hilbish.lua @@ -40,6 +40,10 @@ function hilbish.editor.getVimRegister(register) end --- Inserts text into the line. function hilbish.editor.insert(text) end +--- Reads a keystroke from the user. This is in a format +--- of something like Ctrl-L. +function hilbish.editor.getChar() end + --- Sets the vim register at `register` to hold the passed text. --- @param register string --- @param text string @@ -196,10 +200,14 @@ function hilbish:autoFlush(auto) end --- Flush writes all buffered input to the sink. function hilbish:flush() end ---- Reads input from the sink. +--- Reads a liine of input from the sink. --- @returns string function hilbish:read() end +--- Reads all input from the sink. +--- @returns string +function hilbish:readAll() end + --- Writes data to a sink. function hilbish:write(str) end