emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

master ad624b961b8 1/3: Update tree-sitter traversing functions' docstri


From: Yuan Fu
Subject: master ad624b961b8 1/3: Update tree-sitter traversing functions' docstrings
Date: Wed, 13 Sep 2023 21:15:40 -0400 (EDT)

branch: master
commit ad624b961b84c9f68a9bdda4aa63daf91d46abb9
Author: Yuan Fu <casouri@gmail.com>
Commit: Yuan Fu <casouri@gmail.com>

    Update tree-sitter traversing functions' docstrings
    
    * src/treesit.c (Ftreesit_search_subtree)
    (Ftreesit_search_forward)
    (Ftreesit_induce_sparse_tree): Update docstring.
---
 src/treesit.c | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/src/treesit.c b/src/treesit.c
index 570329ca88b..890091e3419 100644
--- a/src/treesit.c
+++ b/src/treesit.c
@@ -3553,11 +3553,13 @@ DEFUN ("treesit-search-subtree",
        doc: /* Traverse the parse tree of NODE depth-first using PREDICATE.
 
 Traverse the subtree of NODE, and match PREDICATE with each node along
-the way.  PREDICATE can be a regexp string that matches against each
-node's type, a predicate function, and more.  See
-`treesit-thing-settings' for the possible predicates.  PREDICATE can
-also be a thing defined in `treesit-thing-settings'.  Using an
-undefined thing doesn't raise an error.
+the way.
+
+PREDICATE can be a regexp string that matches against each node's
+type, a predicate function, and more.  See `treesit-thing-settings'
+for the possible predicates.  PREDICATE can also be a thing defined in
+`treesit-thing-settings'.  Using an undefined thing doesn't raise an
+error.
 
 By default, only traverse named nodes, but if ALL is non-nil, traverse
 all nodes.  If BACKWARD is non-nil, traverse backwards.  If DEPTH is
@@ -3621,10 +3623,11 @@ DEFUN ("treesit-search-forward",
        doc: /* Search for node matching PREDICATE in the parse tree of START.
 
 Start traversing the tree from node START, and match PREDICATE with
-each node (except START itself) along the way.  PREDICATE can be a
-regexp string that matches against each node's type, a predicate
-function, and more.  See `treesit-thing-settings' for the possible
-predicates.  PREDICATE can also be a thing defined in
+each node (except START itself) along the way.
+
+PREDICATE can be a regexp string that matches against each node's
+type, a predicate function, and more.  See `treesit-thing-settings'
+for the possible predicates.  PREDICATE can also be a thing defined in
 `treesit-thing-settings'.  Using an undefined thing doesn't raise an
 error.
 
@@ -3744,6 +3747,7 @@ DEFUN ("treesit-induce-sparse-tree",
 
 This takes the subtree under ROOT, and combs it so only the nodes that
 match PREDICATE are left, like picking out grapes on the vine.
+
 PREDICATE can be a regexp string that matches against each node's
 type, a predicate function, and more.  See `treesit-thing-settings'
 for the possible predicates.  PREDICATE can also be a thing defined in
@@ -3775,11 +3779,7 @@ ROOT.  If DEPTH is nil or omitted, it defaults to 1000.
 Each node in the returned tree looks like (NODE . (CHILD ...)).  The
 root of this tree might be nil, if ROOT doesn't match PREDICATE.
 
-If no node matches PREDICATE, return nil.
-
-PREDICATE can also be a function that takes a node and returns
-nil/non-nil, but it is slower and more memory consuming than using
-a regexp.  */)
+If no node matches PREDICATE, return nil.  */)
   (Lisp_Object root, Lisp_Object predicate, Lisp_Object process_fn,
    Lisp_Object depth)
 {



reply via email to

[Prev in Thread] Current Thread [Next in Thread]