diff options
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/treesitter.txt | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt index 1402753f15..f6ee2ef425 100644 --- a/runtime/doc/treesitter.txt +++ b/runtime/doc/treesitter.txt @@ -1086,8 +1086,10 @@ Query:iter_captures({node}, {source}, {start}, {stop}) • {node} (`TSNode`) under which the search will occur • {source} (`integer|string`) Source buffer or string to extract text from - • {start} (`integer`) Starting line for the search - • {stop} (`integer`) Stopping line for the search (end-exclusive) + • {start} (`integer?`) Starting line for the search. Defaults to + `node:start()`. + • {stop} (`integer?`) Stopping line for the search (end-exclusive). + Defaults to `node:end_()`. Return: ~ (`fun(end_line: integer?): integer, TSNode, TSMetadata`) capture id, @@ -1119,13 +1121,14 @@ Query:iter_matches({node}, {source}, {start}, {stop}, {opts}) Parameters: ~ • {node} (`TSNode`) under which the search will occur • {source} (`integer|string`) Source buffer or string to search - • {start} (`integer`) Starting line for the search - • {stop} (`integer`) Stopping line for the search (end-exclusive) - • {opts} (`table?`) Options: + • {start} (`integer?`) Starting line for the search. Defaults to + `node:start()`. + • {stop} (`integer?`) Stopping line for the search (end-exclusive). + Defaults to `node:end_()`. + • {opts} (`table?`) Optional keyword arguments: • 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. Requires treesitter >= - 0.20.9. + traversing too deep into a tree. Return: ~ (`fun(): integer, table<integer,TSNode>, table`) pattern id, match, |