; Improve documentation of tree-sitter node comparison

* doc/lispref/parsing.texi (Accessing Node Information):
* src/treesit.c (Ftreesit_node_eq): Improve documentation of node
comparison.

diff --git a/doc/lispref/parsing.texi b/doc/lispref/parsing.texi
index ecba833eb8f23e7062cb038a7a34156e429390a0..e4a252498297d863dfaa2c6a1fcfa2425d903f90 100644 (file)
--- a/doc/lispref/parsing.texi
+++ b/doc/lispref/parsing.texi
@@ -929,9 +929,13 @@ Here are some predicates on tree-sitter nodes:
 Checks if @var{object} is a tree-sitter syntax node.
 @end defun
 
+@cindex compare tree-sitter syntax nodes
+@cindex tree-sitter nodes, comparing
 @defun treesit-node-eq node1 node2
-Checks if @var{node1} and @var{node2} are the same node in a syntax
-tree.  This function uses the same equivalence metric as @code{equal}.
+Checks if @var{node1} and @var{node2} refer to the same node in a
+tree-sitter syntax tree.  This function uses the same equivalence
+metric as @code{equal}.  You can also compare nodes using @code{equal}
+(@pxref{Equality Predicates}).
 @end defun
 
 @heading Property information

diff --git a/src/treesit.c b/src/treesit.c
index d2db91604abf8bed5d9f22a842c8c4f13d411d37..33a7e3c85289881a3eb7b9c6bce83cde73680a16 100644 (file)
--- a/src/treesit.c
+++ b/src/treesit.c
@@ -2167,9 +2167,11 @@ bool treesit_node_eq (Lisp_Object node1, Lisp_Object node2)
 DEFUN ("treesit-node-eq",
        Ftreesit_node_eq,
        Streesit_node_eq, 2, 2, 0,
-       doc: /* Return non-nil if NODE1 and NODE2 are the same node.
+       doc: /* Return non-nil if NODE1 and NODE2 refer to the same node.
 If any one of NODE1 and NODE2 is nil, return nil.
-This function uses the same equivalence metric as `equal'.  */)
+This function uses the same equivalence metric as `equal', and returns
+non-nil if NODE1 and NODE2 refer to the same node in a syntax tree
+produced by tree-sitter.  */)
   (Lisp_Object node1, Lisp_Object node2)
 {
   if (NILP (node1) || NILP (node2))