aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorChristian Clason <c.clason@uni-graz.at>2022-09-12 17:35:49 +0200
committerGitHub <noreply@github.com>2022-09-12 17:35:49 +0200
commitfd70e2bff2440181f63fe124738cf2a025d1e6a5 (patch)
tree5776da6a8f5f396371b624bf1051b884c3e3f4fc /runtime/doc
parent5bc0964b97a77148292addd62867c93c5db29085 (diff)
parenta3272cf452c7df000974d39a5f4b43b4c20990a7 (diff)
downloadrneovim-fd70e2bff2440181f63fe124738cf2a025d1e6a5.tar.gz
rneovim-fd70e2bff2440181f63fe124738cf2a025d1e6a5.tar.bz2
rneovim-fd70e2bff2440181f63fe124738cf2a025d1e6a5.zip
Merge pull request #20141 from vigoux/ts-self-inherits
fix(treesitter): prevent endless loop on self-inheritence docs(treesitter): suggest using extends to extend queries
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/treesitter.txt10
1 files changed, 7 insertions, 3 deletions
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt
index 0a48b435b6..491aea793c 100644
--- a/runtime/doc/treesitter.txt
+++ b/runtime/doc/treesitter.txt
@@ -190,7 +190,7 @@ supported by Neovim.
By default, the first query on `runtimepath` is used (which usually implies
that user config takes precedence over plugins, which take precedence over
queries bundled with Neovim). If a query should extend other queries instead
-of replacing them, use the `; extends` modeline below.
+of replacing them, use |ts-modeline-extends|.
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
@@ -199,16 +199,20 @@ 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.
+ *ts-query-modeline*
Neovim supports to customize the behavior of the queries using a set of
"modelines", that is comments in the queries starting with `;`. Here are the
currently supported modeline alternatives:
- `inherits: {lang}...`
+ `inherits: {lang}...` *ts-modeline-inherits*
Specifies that this query should inherit the queries from {lang}.
This will recursively descend in the queries of {lang} unless wrapped
in parentheses: `({lang})`.
+ Note: this is meant to be used to include queries from another
+ language. If you want your query to extend the queries of the same
+ language, use `extends`.
- `extends`
+ `extends` *ts-modeline-extends*
Specifies that this query should be used as an extension for the
query, i.e. that it should be merged with the others.
Note: the order of the extensions, and the query that will be used as