]> git.eshelyaron.com Git - emacs.git/commitdiff
; Fix the doc strings of 2 treesit.el functions
authorEli Zaretskii <eliz@gnu.org>
Thu, 5 Jan 2023 07:20:02 +0000 (09:20 +0200)
committerEli Zaretskii <eliz@gnu.org>
Thu, 5 Jan 2023 07:20:02 +0000 (09:20 +0200)
* lisp/treesit.el (treesit-parent-until, treesit-parent-while):
Doc fixes.  (Bug#60531)

lisp/treesit.el

index ed0aa1c8612d71bd366706b6300c9c353a1d61d7..d6822669014855d660876d6ce28fbc9195617d4a 100644 (file)
@@ -303,8 +303,8 @@ properties."
   "Return the closest parent of NODE that satisfies PRED.
 
 Return nil if none was found.  PRED should be a function that
-takes one argument, the parent node, and return non-nil/nil for
-match/no match.
+takes one argument, the node to examine, and returns a boolean
+value indicating whether that node is a match.
 
 If INCLUDE-NODE is non-nil, return NODE if it satisfies PRED."
   (let ((node (if include-node node
@@ -316,7 +316,8 @@ If INCLUDE-NODE is non-nil, return NODE if it satisfies PRED."
 (defun treesit-parent-while (node pred)
   "Return the furthest parent of NODE that satisfies PRED.
 Return nil if none was found.  PRED should be a function that
-takes one argument, the parent node."
+takes one argument, the node to examine, and returns a boolean
+value indicating whether that node is a match."
   (let ((last nil))
     (while (and node (funcall pred node))
       (setq last node