From 4ef50ccd3f8bc177ef6dd7183a9268bb8057f064 Mon Sep 17 00:00:00 2001 From: Yuan Fu Date: Mon, 31 Oct 2022 15:11:44 -0700 Subject: [PATCH] ; Explain the BEG and END argument in treesit-query-capture better * doc/lispref/parsing.texi (Pattern Matching): Update manual. * src/treesit.c (Ftreesit_query_capture): Update docstring. --- doc/lispref/parsing.texi | 4 +++- src/treesit.c | 6 ++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/lispref/parsing.texi b/doc/lispref/parsing.texi index 524b81a2bbd..7164baaa6d2 100644 --- a/doc/lispref/parsing.texi +++ b/doc/lispref/parsing.texi @@ -992,7 +992,9 @@ The function returns all the captured nodes in a list of the form non-@code{nil}, it returns the list of nodes instead. By default the entire text of @var{node} is searched, but if @var{beg} and @var{end} are both non-@code{nil}, they specify the region of buffer text where -this function should match nodes. +this function should match nodes. Any matching node whose span +overlaps with the region between @var{beg} and @var{end} are captured, +it doesn't have to be completely in the region. @vindex treesit-query-error @findex treesit-query-validate diff --git a/src/treesit.c b/src/treesit.c index e4be065d94a..9324b8b1006 100644 --- a/src/treesit.c +++ b/src/treesit.c @@ -2178,8 +2178,10 @@ either string or sexp form. When using repeatedly, a compiled query is much faster than a string or sexp one, so it is recommend to compile your query if it will be used repeatedly. -BEG and END, if both non-nil, specify the region of buffer positions -in which the query is executed. +BEG and END, if both non-nil, specify the region of buffer positions +in which the query is executed. Any matching node whose span overlaps +with the region between BEG and END are captured, it doesn't have to +be completely in the region. If NODE-ONLY is non-nil, return a list of nodes. -- 2.39.5