aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYuan Fu2022-11-21 22:33:10 -0800
committerYuan Fu2022-11-22 01:06:51 -0800
commitc7202e7f4aedee607f26727de52b85819bf64dab (patch)
tree0936b16a7b6c06e77676d1467d116a865f0482c9
parent74892eefc8dd5b442a1859c7d28422778b79ce3c (diff)
downloademacs-c7202e7f4aedee607f26727de52b85819bf64dab.tar.gz
emacs-c7202e7f4aedee607f26727de52b85819bf64dab.zip
; Fix docstrings in treesit.el
* lisp/treesit.el (treesit--explorer--nodes-to-highlight) (treesit--explorer-draw-node): Fix docstrings.
-rw-r--r--lisp/treesit.el18
1 files changed, 8 insertions, 10 deletions
diff --git a/lisp/treesit.el b/lisp/treesit.el
index 24387c287a7..015f780078f 100644
--- a/lisp/treesit.el
+++ b/lisp/treesit.el
@@ -1765,10 +1765,11 @@ to the offending pattern and highlight the pattern."
1765 1765
1766(defun treesit--explorer--nodes-to-highlight (language) 1766(defun treesit--explorer--nodes-to-highlight (language)
1767 "Return nodes for LANGUAGE covered in region. 1767 "Return nodes for LANGUAGE covered in region.
1768This function tries to return the largest node possible. So it 1768This function tries to return the largest node possible. If the
1769will return a single large node rather than a bunch of small 1769region covers exactly one node, that node is returned (in a
1770nodes. If it end up returning multiple small nodes, it only 1770list). If the region covers more than one node, two nodes are
1771returns the first and last node, and omits the ones in between." 1771returned: the very first one in the region and the very last one
1772in the region."
1772 (let* ((beg (region-beginning)) 1773 (let* ((beg (region-beginning))
1773 (end (region-end)) 1774 (end (region-end))
1774 (node (treesit-node-on beg end language)) 1775 (node (treesit-node-on beg end language))
@@ -1887,13 +1888,10 @@ Return the start of the syntax tree text corresponding to NODE."
1887 1888
1888(defun treesit--explorer-draw-node (node) 1889(defun treesit--explorer-draw-node (node)
1889 "Draw the syntax tree of NODE. 1890 "Draw the syntax tree of NODE.
1890If NODE and NODE-HIGHLIGHT are the same node, highlight it.
1891 1891
1892When this function is called, point should be at an empty line, 1892When this function is called, point should be at the position
1893when appropriate indent in front of point. When this function 1893where the node should start. When this function returns, it
1894returns, it leaves point at the end of the last line of NODE. 1894leaves point at the end of the last line of NODE."
1895
1896Return the start position of NODE-HIGHLIGHT in the buffer, if any."
1897 (let* ((type (treesit-node-type node)) 1895 (let* ((type (treesit-node-type node))
1898 (field-name (treesit-node-field-name node)) 1896 (field-name (treesit-node-field-name node))
1899 (children (treesit-node-children node)) 1897 (children (treesit-node-children node))