mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-26 12:27:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(treesitter): fix parameter list for Query:iter_matches (#34553)

Browse Source
This commit is contained in:
Luis Calle
2025-06-22 05:38:00 -05:00
committed by GitHub
parent ee2fc31b36
commit cfb4d3d2f2
2 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
runtime/doc/treesitter.txt
View File

@@ -1524,11 +1524,12 @@ Query:iter_matches({node}, {source}, {start}, {stop}, {opts})
start depth for each match. This is used to prevent start depth for each match. This is used to prevent
traversing too deep into a tree. traversing too deep into a tree.
• match_limit (integer) Set the maximum number of • match_limit (integer) Set the maximum number of
in-progress matches (Default: 256). all (boolean) When in-progress matches (Default: 256).
`false` (default `true`), the returned table maps capture • all (boolean) When `false` (default `true`), the returned
IDs to a single (last) node instead of the full list of table maps capture IDs to a single (last) node instead of
matching nodes. This option is only for backward the full list of matching nodes. This option is only for
compatibility and will be removed in a future release. backward compatibility and will be removed in a future
release.
Return: ~ Return: ~
(`fun(): integer, table<integer, TSNode[]>, vim.treesitter.query.TSMetadata, TSTree`) (`fun(): integer, table<integer, TSNode[]>, vim.treesitter.query.TSMetadata, TSTree`)

6
runtime/lua/vim/treesitter/query.lua
View File

@@ -1056,9 +1056,9 @@ end
--- - max_start_depth (integer) if non-zero, sets the maximum start depth --- - max_start_depth (integer) if non-zero, sets the maximum start depth
--- for each match. This is used to prevent traversing too deep into a tree. --- for each match. This is used to prevent traversing too deep into a tree.
--- - match_limit (integer) Set the maximum number of in-progress matches (Default: 256). --- - match_limit (integer) Set the maximum number of in-progress matches (Default: 256).
--- - all (boolean) When `false` (default `true`), the returned table maps capture IDs to a single --- - all (boolean) When `false` (default `true`), the returned table maps capture IDs to a single
--- (last) node instead of the full list of matching nodes. This option is only for backward --- (last) node instead of the full list of matching nodes. This option is only for backward
--- compatibility and will be removed in a future release. --- compatibility and will be removed in a future release.
--- ---
---@return (fun(): integer, table<integer, TSNode[]>, vim.treesitter.query.TSMetadata, TSTree): pattern id, match, metadata, tree ---@return (fun(): integer, table<integer, TSNode[]>, vim.treesitter.query.TSMetadata, TSTree): pattern id, match, metadata, tree
function Query:iter_matches(node, source, start, stop, opts) function Query:iter_matches(node, source, start, stop, opts)