aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/treesitter.txt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc/treesitter.txt')
-rw-r--r--runtime/doc/treesitter.txt6
1 files changed, 5 insertions, 1 deletions
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt
index 7ee3769bbd..e105d06ebb 100644
--- a/runtime/doc/treesitter.txt
+++ b/runtime/doc/treesitter.txt
@@ -1321,7 +1321,11 @@ LanguageTree:included_regions() *LanguageTree:included_regions()*
(`table<integer, Range6[]>`)
LanguageTree:invalidate({reload}) *LanguageTree:invalidate()*
- Invalidates this parser and all its children
+ Invalidates this parser and its children.
+
+ Should only be called when the tracked state of the LanguageTree is not
+ valid against the parse tree in treesitter. Doesn't clear filesystem
+ cache. Called often, so needs to be fast.
Parameters: ~
• {reload} (`boolean?`)