Skip to content

Commit

Permalink
docs: clarify context_size with an explicit example (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikavilpas authored Dec 11, 2024
1 parent 70a5a17 commit 05bea91
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ return {
-- (if the word is shorter than this, the search will not start)
prefix_min_len = 3,

-- The number of lines to show around each match in the preview window
-- The number of lines to show around each match in the preview window.
-- For example, 5 means to show 5 lines before, then the match, and
-- another 5 lines after the match.
context_size = 5,

-- The maximum file size that ripgrep should include in its search.
Expand Down
2 changes: 1 addition & 1 deletion lua/blink-ripgrep/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
---@field prefix_min_len? number # The minimum length of the current word to start searching (if the word is shorter than this, the search will not start)
---@field get_command? fun(context: blink.cmp.Context, prefix: string): string[] # Changing this might break things - if you need some customization, please open and issue 🙂
---@field get_prefix? fun(context: blink.cmp.Context): string
---@field context_size? number # The number of lines to show around each match in the preview window
---@field context_size? number # The number of lines to show around each match in the preview window. For example, 5 means to show 5 lines before, then the match, and another 5 lines after the match.
---@field max_filesize? string # The maximum file size that ripgrep should include in its search. Examples: "1024" (bytes by default), "200K", "1M", "1G"

---@class blink-ripgrep.RgSource : blink.cmp.Source
Expand Down

0 comments on commit 05bea91

Please sign in to comment.