Skip to content

Commit

Permalink
docs: expose GpConfig
Browse files Browse the repository at this point in the history
  • Loading branch information
ofseed authored and Robitx committed Sep 10, 2024
1 parent 861ed52 commit 6a8238c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions lua/gp/config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
-- Default config
--------------------------------------------------------------------------------

---@class GpConfig
-- README_REFERENCE_MARKER_START
local config = {
-- Please start with minimal config possible.
Expand Down Expand Up @@ -317,11 +318,12 @@ local config = {
-- use prompt buftype for chats (:h prompt-buffer)
chat_prompt_buf_type = false,

-- how to display GpChatToggle or GpContext: popup / split / vsplit / tabnew
-- how to display GpChatToggle or GpContext
---@type "popup" | "split" | "vsplit" | "tabnew"
toggle_target = "vsplit",

-- styling for chatfinder
-- border can be "single", "double", "rounded", "solid", "shadow", "none"
---@type "single" | "double" | "rounded" | "solid" | "shadow" | "none"
style_chat_finder_border = "single",
-- margins are number of characters or lines
style_chat_finder_margin_bottom = 8,
Expand All @@ -332,7 +334,7 @@ local config = {
style_chat_finder_preview_ratio = 0.5,

-- styling for popup
-- border can be "single", "double", "rounded", "solid", "shadow", "none"
---@type "single" | "double" | "rounded" | "solid" | "shadow" | "none"
style_popup_border = "single",
-- margins are number of characters or lines
style_popup_margin_bottom = 8,
Expand Down
2 changes: 1 addition & 1 deletion lua/gp/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ end

-- setup function
M._setup_called = false
---@param opts table | nil # table with options
---@param opts GpConfig? # table with options
M.setup = function(opts)
M._setup_called = true

Expand Down

0 comments on commit 6a8238c

Please sign in to comment.