diff options
author | ElPiloto <luis.r.piloto@gmail.com> | 2020-11-04 19:55:12 +0000 |
---|---|---|
committer | ElPiloto <luis.r.piloto@gmail.com> | 2020-11-04 19:55:12 +0000 |
commit | d1bed9677852cc610c64391df348a642851efda9 (patch) | |
tree | 3351e62491c798c09fbc4243a05c39f7bd20aedd | |
parent | 44180c355377cdfe2ca20f688702d71934124ece (diff) | |
download | rneovim-d1bed9677852cc610c64391df348a642851efda9.tar.gz rneovim-d1bed9677852cc610c64391df348a642851efda9.tar.bz2 rneovim-d1bed9677852cc610c64391df348a642851efda9.zip |
doc: Fix treesitter doc PR.
-rw-r--r-- | runtime/doc/treesitter.txt | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt index 8bedc0153e..9f0d529b9a 100644 --- a/runtime/doc/treesitter.txt +++ b/runtime/doc/treesitter.txt @@ -164,11 +164,11 @@ Tree-sitter queries are supported, with some limitations. Currently, the only supported match predicate is `eq?` (both comparing a capture against a string and two captures against each other). -A |query| consists of one or more patterns. A |pattern| is defined over node -types in the syntax tree. A |match| corresponds to specific elements of the +A `query` consists of one or more patterns. A `pattern` is defined over node +types in the syntax tree. A `match` corresponds to specific elements of the syntax tree which match a pattern. Patterns may optionally define captures -and predicates. A |capture| allows you to associate names with a specific -node in a pattern. A |predicate| adds arbitrary metadata and conditional data +and predicates. A `capture` allows you to associate names with a specific +node in a pattern. A `predicate` adds arbitrary metadata and conditional data to a match. vim.treesitter.parse_query({lang}, {query}) @@ -176,10 +176,10 @@ vim.treesitter.parse_query({lang}, {query}) Parse {query} as a string. (If the query is in a file, the caller should read the contents into a string before calling). - Returns a |Query| object which can be used to search nodes in the - syntax tree for the patterns defined in {query} using `iter_*` methods - below. Exposes `info` and `captures` with additional information about - the {query}. + Returns a |lua-treesitter-query| Query object which can be used to + search nodes in the syntax tree for the patterns defined in {query} + using `iter_*` methods below. Exposes `info` and `captures` with + additional information about the {query}. - `captures` contains the list of unique capture names defined in {query}. -` info.captures` also points to `captures`. |