Skip to content

Commit

Permalink
docs: improve treesitter highlighting doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Saghen committed Nov 15, 2024
1 parent 1c14f8e commit f581f98
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ MiniDeps.add({
auto_show = false,
auto_show_delay_ms = 500,
update_delay_ms = 50,
-- whether to use treesitter highlighting for the documentation window, disable if you run into performance issues
-- whether to use treesitter highlighting, disable if you run into performance issues
-- WARN: temporary, eventually blink will support regex highlighting
treesitter_highlighting = true,
},
Expand All @@ -523,7 +523,7 @@ MiniDeps.add({
-- which directions to show the window,
-- falling back to the next direction when there's not enough space
direction_priority = { 'n', 's' },
-- whether to use treesitter highlighting for the documentation window, disable if you run into performance issues
-- whether to use treesitter highlighting, disable if you run into performance issues
-- WARN: temporary, eventually blink will support regex highlighting
treesitter_highlighting = true,
},
Expand Down
8 changes: 4 additions & 4 deletions lua/blink/cmp/config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@
--- @field auto_show? boolean
--- @field auto_show_delay_ms? number Delay before showing the documentation window
--- @field update_delay_ms? number Delay before updating the documentation window
--- @field treesitter_highlighting? boolean Whether to use treesitter highlighting for the documentation window, disable if you run into performance issues
--- @field treesitter_highlighting? boolean Whether to use treesitter highlighting, disable if you run into performance issues

--- @class blink.cmp.SignatureHelpConfig
--- @field min_width? number
Expand All @@ -163,7 +163,7 @@
--- @field winhighlight? string
--- @field scrollbar? boolean
--- @field direction_priority? ("n" | "s")[]
--- @field treesitter_highlighting? boolean Whether to use treesitter highlighting for the documentation window, disable if you run into performance issues
--- @field treesitter_highlighting? boolean Whether to use treesitter highlighting, disable if you run into performance issues

--- @class GhostTextConfig
--- @field enabled? boolean
Expand Down Expand Up @@ -495,7 +495,7 @@ local config = {
auto_show = false,
auto_show_delay_ms = 500,
update_delay_ms = 50,
-- whether to use treesitter highlighting for the documentation window, disable if you run into performance issues
-- whether to use treesitter highlighting, disable if you run into performance issues
-- WARN: temporary, eventually blink will support regex highlighting
treesitter_highlighting = true,
},
Expand All @@ -512,7 +512,7 @@ local config = {
-- which directions to show the window,
-- falling back to the next direction when there's not enough space
direction_priority = { 'n', 's' },
-- whether to use treesitter highlighting for the documentation window, disable if you run into performance issues
-- whether to use treesitter highlighting, disable if you run into performance issues
-- WARN: temporary, eventually blink will support regex highlighting
treesitter_highlighting = true,
},
Expand Down

0 comments on commit f581f98

Please sign in to comment.