diff --git a/README.md b/README.md index a3d2ed5..978d394 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/lua/blink-ripgrep/init.lua b/lua/blink-ripgrep/init.lua index 01d7502..79cf751 100644 --- a/lua/blink-ripgrep/init.lua +++ b/lua/blink-ripgrep/init.lua @@ -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