From 76c94bfcce0d5453b5679d9b5f32f923f6c56da1 Mon Sep 17 00:00:00 2001 From: TorchedSammy <38820196+TorchedSammy@users.noreply.github.com> Date: Sat, 5 Mar 2022 16:12:46 -0400 Subject: [PATCH] docs: fix docs for hilbish.complete --- api.go | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/api.go b/api.go index ed199a8..5c83889 100644 --- a/api.go +++ b/api.go @@ -400,8 +400,10 @@ func hlinterval(L *lua.LState) int { // Registers a completion handler for `scope`. // A `scope` is currently only expected to be `command.`, // replacing with the name of the command (for example `command.git`). -// `cb` must be a function that returns a table of the entries to complete. -// Nested tables will be used as sub-completions. +// `cb` must be a function that returns a table of "completion groups." +// A completion group is a table with the keys `items` and `type`. +// `items` being a table of items and `type` being the display type of +// `grid` (the normal file completion display) or `list` (with a description) // --- @param scope string // --- @param cb function func hlcomplete(L *lua.LState) int {