]> git.eshelyaron.com Git - emacs.git/commitdiff
; Fix vindexes in parsing.texi
authorYuan Fu <casouri@gmail.com>
Mon, 26 Dec 2022 09:39:02 +0000 (01:39 -0800)
committerYuan Fu <casouri@gmail.com>
Mon, 26 Dec 2022 09:47:56 +0000 (01:47 -0800)
* doc/lispref/parsing.texi (Tree-sitter major modes): Replace vindex
with cross-reference to modes.texi.  Add manual entry for
treesit-defun-type-regexp.
* lisp/treesit.el (treesit-defun-type-regexp): Use pred in docstring
since we use pred everywhere else.

doc/lispref/parsing.texi
lisp/treesit.el

index 4b9cd18dd47064985063cea97fe76291467ed2a5..5d1b11935cf910ecbe18079172711f415df82a34 100644 (file)
@@ -1715,17 +1715,14 @@ This function activates some tree-sitter features for a major mode.
 
 Currently, it sets up the following features:
 @itemize
-@vindex treesit-font-lock-settings
 @item
-If @code{treesit-font-lock-settings} is non-@code{nil}, it sets up
-fontification.
+If @code{treesit-font-lock-settings} (@pxref{Parser-based Font Lock})
+is non-@code{nil}, it sets up fontification.
 
-@vindex treesit-simple-indent-rules
 @item
-If @code{treesit-simple-indent-rules} is non-@code{nil}, it sets up
-indentation.
+If @code{treesit-simple-indent-rules} (@pxref{Parser-based Font Lock})
+is non-@code{nil}, it sets up indentation.
 
-@vindex treesit-defun-type-regexp
 @item
 If @code{treesit-defun-type-regexp} is non-@code{nil}, it sets up
 navigation functions for @code{beginning-of-defun} and
@@ -1782,6 +1779,17 @@ node is a defun node but doesn't have a name, or the node is
 @code{nil}, it should return @code{nil}.
 @end defvar
 
+@defvar treesit-defun-type-regexp
+This variable determines which nodes are considered defuns by Emacs.
+It can be a regexp that matches the type of defun nodes.
+
+Sometimes not all nodes matched by the regexp are valid defuns.
+Therefore, this variable can also be a cons cell of the form
+@w{(@var{regexp} . @var{pred})}, where @var{pred} should be a function
+that takes a node as its argument, and returns @code{t} if the node is
+valid defun, or @code{nil} if it is not valid.
+@end defvar
+
 @node Tree-sitter C API
 @section Tree-sitter C API Correspondence
 
index f3e1afd943ef0659ff8156b6b9d81cc0662298b6..2130cd00616ad7f0d34cbe591321cf2eb4e22fe0 100644 (file)
@@ -1622,7 +1622,7 @@ For example, \"(function|class)_definition\".
 
 Sometimes not all nodes matched by the regexp are valid defuns.
 In that case, set this variable to a cons cell of the
-form (REGEXP . FILTER), where FILTER is a function that takes a
+form (REGEXP . PRED), where PRED is a function that takes a
 node (the matched node) and returns t if node is valid, or nil
 for invalid node.