Skip to content

Commit

Permalink
refactor: add comment (#72)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikavilpas authored Dec 21, 2024
1 parent 6b72c1b commit acbbee4
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions lua/blink-ripgrep/ripgrep_parser.lua
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ local function get_file_context(json, output)
return file, line_number
end

-- When ripgrep is run with the `--json` flag, it outputs a stream of jsonl
-- (json lines) objects. They show what matched the search as well as lines
-- surrounding each match.
-- This function converts the jsonl stream into a table.
--
---@param ripgrep_output string[] ripgrep output in jsonl format
---@param cwd string the current working directory
---@param context_size number the number of lines of context to include in the output
Expand Down

0 comments on commit acbbee4

Please sign in to comment.