summaryrefslogtreecommitdiff
path: root/src/treesit.c
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2023-01-13 09:13:24 +0200
committerEli Zaretskii <eliz@gnu.org>2023-01-13 09:13:24 +0200
commitdfb38fb2ee623a78f7e7e15e0b6f11e4768cef48 (patch)
treed4e40e655c01818eb697ca6d5be4c60b5affd3d6 /src/treesit.c
parente8a89a18b69cc8da2ab5ab4dcf1564f0e4517509 (diff)
downloademacs-dfb38fb2ee623a78f7e7e15e0b6f11e4768cef48.tar.gz
emacs-dfb38fb2ee623a78f7e7e15e0b6f11e4768cef48.tar.bz2
emacs-dfb38fb2ee623a78f7e7e15e0b6f11e4768cef48.zip
; 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.
Diffstat (limited to 'src/treesit.c')
-rw-r--r--src/treesit.c6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/treesit.c b/src/treesit.c
index d2db91604ab..33a7e3c8528 100644
--- 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))