1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-06 23:51:24 -08:00

; 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.
This commit is contained in:
Yuan Fu 2022-10-31 15:11:44 -07:00
parent b49250ada9
commit 4ef50ccd3f
No known key found for this signature in database
GPG key ID: 56E19BC57664A442
2 changed files with 7 additions and 3 deletions

View file

@ -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

View file

@ -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.