From: Yuan Fu <casouri@gmail.com>
Date: Tue, 24 Dec 2024 05:20:18 +0000 (-0800)
Subject: ; Add some shortdoc examples for treesit entry
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=a42daef888ea351feddf14837fb7469b872ebed5;p=emacs.git

; Add some shortdoc examples for treesit entry

* lisp/treesit.el: Add some shortdoc examples.

(cherry picked from commit 833494d4b00a837be8ceaa09b37f54ce17d0a062)
---

diff --git a/lisp/treesit.el b/lisp/treesit.el
index 49de28a9a6e..86c1fa38388 100644
--- a/lisp/treesit.el
+++ b/lisp/treesit.el
@@ -4367,6 +4367,22 @@ generated by \"git describe\".  It only works when
    :eval (treesit-pattern-expand '(identifier))
    :eval (treesit-pattern-expand :equal))
 
+  "Tree-sitter things and navigation"
+  (treesit-thing-defined-p
+   :no-eval (treesit-thing-defined-p 'sexp)
+   :eg-result nil)
+  (treesit-thing-definition
+   :no-eval (treesit-thing-defined 'sexp)
+   :eg-result (not ,(rx (or "{" "}" "[" "]" "(" ")" ","))))
+  (treesit-thing-at
+   :no-eval (treesit-thing-at 3943)
+   :eg-result-string "#<treesit-node (identifier) in 3941-3949>")
+  (treesit-thing-next
+   :no-eval (treesit-thing-next 3943 'sexp))
+  (treesit-navigate-thing
+   :no-eval (treesit-navigate-thing 3943 1 'beg 'sexp))
+  (treesit-beginning-of-thing
+   :no-eval (treesit-beginning-of-thing 'defun 1 'nested))
 
   "Parsing a string"
   (treesit-parse-string
@@ -4379,7 +4395,15 @@ generated by \"git describe\".  It only works when
   "Misc"
   (treesit-subtree-stat
    :no-eval (treesit-subtree-stat node)
-   :eg-result (6 33 487)))
+   :eg-result (6 33 487))
+  (treesit-language-abi-version
+   :no-eval (treesit-language-abi-version 'c)
+   :eg-result 14)
+  (treesit-grammar-location
+   :no-eval (treesit-language-abi-version 'c))
+  (treesit-language-display-name
+   :no-eval (treesit-language-display-name 'cpp)
+   :eg-result "C++"))
 
 (provide 'treesit)