Skip to content

Commit 6a8238c

Browse files
ofseedRobitx
authored andcommitted
docs: expose GpConfig
1 parent 861ed52 commit 6a8238c

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

lua/gp/config.lua

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
-- Default config
66
--------------------------------------------------------------------------------
77

8+
---@class GpConfig
89
-- README_REFERENCE_MARKER_START
910
local config = {
1011
-- Please start with minimal config possible.
@@ -317,11 +318,12 @@ local config = {
317318
-- use prompt buftype for chats (:h prompt-buffer)
318319
chat_prompt_buf_type = false,
319320

320-
-- how to display GpChatToggle or GpContext: popup / split / vsplit / tabnew
321+
-- how to display GpChatToggle or GpContext
322+
---@type "popup" | "split" | "vsplit" | "tabnew"
321323
toggle_target = "vsplit",
322324

323325
-- styling for chatfinder
324-
-- border can be "single", "double", "rounded", "solid", "shadow", "none"
326+
---@type "single" | "double" | "rounded" | "solid" | "shadow" | "none"
325327
style_chat_finder_border = "single",
326328
-- margins are number of characters or lines
327329
style_chat_finder_margin_bottom = 8,
@@ -332,7 +334,7 @@ local config = {
332334
style_chat_finder_preview_ratio = 0.5,
333335

334336
-- styling for popup
335-
-- border can be "single", "double", "rounded", "solid", "shadow", "none"
337+
---@type "single" | "double" | "rounded" | "solid" | "shadow" | "none"
336338
style_popup_border = "single",
337339
-- margins are number of characters or lines
338340
style_popup_margin_bottom = 8,

lua/gp/init.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ end
4141

4242
-- setup function
4343
M._setup_called = false
44-
---@param opts table | nil # table with options
44+
---@param opts GpConfig? # table with options
4545
M.setup = function(opts)
4646
M._setup_called = true
4747

0 commit comments

Comments
 (0)