[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 28cb3a44135: ; Fix recent changes in treesit documentation
From: |
Eli Zaretskii |
Subject: |
master 28cb3a44135: ; Fix recent changes in treesit documentation |
Date: |
Thu, 7 Sep 2023 04:10:52 -0400 (EDT) |
branch: master
commit 28cb3a441351c8235573920430273a29c7f88227
Author: Eli Zaretskii <eliz@gnu.org>
Commit: Eli Zaretskii <eliz@gnu.org>
; Fix recent changes in treesit documentation
* lisp/treesit.el (treesit-local-parsers-at)
(treesit-local-parsers-in):
* doc/lispref/parsing.texi (Multiple Languages):
(Using Parser): Fix wording of recently added docs.
---
doc/lispref/parsing.texi | 33 ++++++++++++++++++---------------
lisp/treesit.el | 19 +++++++++----------
2 files changed, 27 insertions(+), 25 deletions(-)
diff --git a/doc/lispref/parsing.texi b/doc/lispref/parsing.texi
index a0479050f27..3e5cbbec95b 100644
--- a/doc/lispref/parsing.texi
+++ b/doc/lispref/parsing.texi
@@ -461,7 +461,7 @@ indirect buffer, its base buffer is used instead. That is,
indirect
buffers use their base buffer's parsers.
If @var{language} is non-@var{nil}, only include parsers for that
-language. And only include parsers with @var{tag}. @var{tag} defaults
+language, and only include parsers with @var{tag}. @var{tag} defaults
to @code{nil}. If @var{tag} is @code{t}, include parsers in the
returned list regardless of their tag.
@end defun
@@ -1716,16 +1716,17 @@ specifies the embedded language, and the @code{:host}
keyword
specifies the host language.
@cindex local parser
-If the query is given a @code{:local} keyword, and the value is
+If the query is given the @code{:local} keyword whose value is
@code{t}, the range set by this query has a dedicated local parser;
otherwise the range shares a parser with other ranges for the same
language.
-A parser sees view its ranges continuously, rather than viewing them
-as independent segments. Therefore, if the embedded range are
-semantically independent segments, use local parsers for them.
+By default, a parser sees its ranges as a continuum, rather than
+treating them as separate independent segments. Therefore, if the
+embedded ranges are semantically independent segments, they should be
+processed by local parsers, described below.
-Local parser set to a range can be retrieved by
+The local parser set to a range can be retrieved by
@code{treesit-local-parsers-at} and @code{treesit-local-parsers-in}.
@code{treesit-update-ranges} uses @var{query} to figure out how to set
@@ -1764,20 +1765,22 @@ language of the buffer text at @var{pos}. This
variable is used by
@end defvar
@defun treesit-local-parsers-at &optional pos language
-This function returns all the local parsers at @var{pos}.
+This function returns all the local parsers at @var{pos} in the
+current buffer. @var{pos} defaults to point.
-Local parsers are those who only parses a limited region marked by an
-overlay. If @var{language} is non-@code{nil}, only return parsers for
-that language.
-
-@var{pos} defaults to point.
+Local parsers are those which only parse a limited region marked by an
+overlay with a non-@code{nil} @code{treesit-parser} property. If
+@var{language} is non-@code{nil}, only return parsers for that
+language.
@end defun
@defun treesit-local-parsers-on &optional beg end language
-This function is the same as @code{treesit-local-parsers-at}, but gets
-the local parsers in a range instead of at a point.
+This function is the same as @code{treesit-local-parsers-at}, but it
+returns the local parsers in the range between @var{beg} and @var{end}
+instead of at point.
-@var{beg} and @var{end} default to cover the whole buffer.
+@var{beg} and @var{end} default to the entire accessible portion of
+the buffer.
@end defun
@node Tree-sitter Major Modes
diff --git a/lisp/treesit.el b/lisp/treesit.el
index 3ad7a851f67..6fefc122582 100644
--- a/lisp/treesit.el
+++ b/lisp/treesit.el
@@ -589,11 +589,10 @@ those inside are kept."
(defun treesit-local-parsers-at (&optional pos language)
"Return all the local parsers at POS.
-Local parsers are those who only parses a limited region marked
-by an overlay. If LANGUAGE is non-nil, only return parsers for
-that language.
-
-POS defaults to point."
+POS defaults to point.
+Local parsers are those which only parse a limited region marked
+by an overlay with non-nil `treesit-parser' property.
+If LANGUAGE is non-nil, only return parsers for LANGUAGE."
(let ((res nil))
(dolist (ov (overlays-at (or pos (point))))
(when-let ((parser (overlay-get ov 'treesit-parser)))
@@ -606,11 +605,11 @@ POS defaults to point."
(defun treesit-local-parsers-in (&optional beg end language)
"Return all the local parsers between BEG END.
-Local parsers are those who has an `embedded' tag, and only
-parses a limited region marked by an overlay. If LANGUAGE is
-non-nil, only return parsers for that language.
-
-BEG and END default to cover the whole buffer."
+BEG and END default to the beginning and end of the buffer's
+accessible portion.
+Local parsers are those which have an `embedded' tag, and only parse
+a limited region marked by an overlay with a non-nil `treesit-parser'
+property. If LANGUAGE is non-nil, only return parsers for LANGUAGE."
(let ((res nil))
(dolist (ov (overlays-in (or beg (point-min)) (or end (point-max))))
(when-let ((parser (overlay-get ov 'treesit-parser)))
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master 28cb3a44135: ; Fix recent changes in treesit documentation,
Eli Zaretskii <=