From 1a4585aa7a3173705edb2de984f1a2aab2a96010 Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Sat, 2 Dec 2023 15:17:32 +0000 Subject: [PATCH] docs: [ci] generate new docs --- docs/api/hilbish/hilbish.completion.md | 29 ++++++++++++++++++++++++++ emmyLuaDocs/hilbish.lua | 8 +++---- 2 files changed, 33 insertions(+), 4 deletions(-) create mode 100644 docs/api/hilbish/hilbish.completion.md diff --git a/docs/api/hilbish/hilbish.completion.md b/docs/api/hilbish/hilbish.completion.md new file mode 100644 index 0000000..8bee704 --- /dev/null +++ b/docs/api/hilbish/hilbish.completion.md @@ -0,0 +1,29 @@ +--- +title: Interface hilbish.completion +description: tab completions +layout: doc +menu: + docs: + parent: "API" +--- + +## Introduction +The completions interface deals with tab completions. + +## Functions +### call(name, query, ctx, fields) -> completionGroups (table), prefix (string) +Calls a completer function. This is mainly used to call +a command completer, which will have a `name` in the form +of `command.name`, example: `command.git`. +You can check `doc completions` for info on the `completionGroups` return value. + +### handler(line, pos) +The handler function is the callback for tab completion in Hilbish. +You can check the completions doc for more info. + +### bins(query, ctx, fields) -> entries (table), prefix (string) +Returns binary/executale completion candidates based on the provided query. + +### files(query, ctx, fields) -> entries (table), prefix (string) +Returns file completion candidates based on the provided query. + diff --git a/emmyLuaDocs/hilbish.lua b/emmyLuaDocs/hilbish.lua index 2ee93ed..0d38c61 100644 --- a/emmyLuaDocs/hilbish.lua +++ b/emmyLuaDocs/hilbish.lua @@ -22,13 +22,13 @@ function hilbish.runner.setMode(cb) end --- @param query string --- @param ctx string --- @param fields table -function hilbish.completions.call(name, query, ctx, fields) end +function hilbish.completion.call(name, query, ctx, fields) end --- The handler function is the callback for tab completion in Hilbish. --- You can check the completions doc for more info. --- @param line string --- @param pos string -function hilbish.completions.handler(line, pos) end +function hilbish.completion.handler(line, pos) end --- Returns the current input line. function hilbish.editor.getLine() end @@ -175,13 +175,13 @@ function hilbish.jobs:background() end --- @param query string --- @param ctx string --- @param fields table -function hilbish.completions.bins(query, ctx, fields) end +function hilbish.completion.bins(query, ctx, fields) end --- Returns file completion candidates based on the provided query. --- @param query string --- @param ctx string --- @param fields table -function hilbish.completions.files(query, ctx, fields) end +function hilbish.completion.files(query, ctx, fields) end --- Puts a job in the foreground. This will cause it to run like it was --- executed normally and wait for it to complete.