diff options
| author | Yuan Fu <casouri@gmail.com> | 2022-11-21 22:33:10 -0800 |
|---|---|---|
| committer | Yuan Fu <casouri@gmail.com> | 2022-11-22 01:06:51 -0800 |
| commit | c7202e7f4aedee607f26727de52b85819bf64dab (patch) | |
| tree | 0936b16a7b6c06e77676d1467d116a865f0482c9 /lisp/treesit.el | |
| parent | 74892eefc8dd5b442a1859c7d28422778b79ce3c (diff) | |
| download | emacs-c7202e7f4aedee607f26727de52b85819bf64dab.tar.gz emacs-c7202e7f4aedee607f26727de52b85819bf64dab.tar.bz2 emacs-c7202e7f4aedee607f26727de52b85819bf64dab.zip | |
; Fix docstrings in treesit.el
* lisp/treesit.el (treesit--explorer--nodes-to-highlight)
(treesit--explorer-draw-node): Fix docstrings.
Diffstat (limited to 'lisp/treesit.el')
| -rw-r--r-- | lisp/treesit.el | 18 |
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." (defun treesit--explorer--nodes-to-highlight (language) "Return nodes for LANGUAGE covered in region. -This function tries to return the largest node possible. So it -will return a single large node rather than a bunch of small -nodes. If it end up returning multiple small nodes, it only -returns the first and last node, and omits the ones in between." +This function tries to return the largest node possible. If the +region covers exactly one node, that node is returned (in a +list). If the region covers more than one node, two nodes are +returned: the very first one in the region and the very last one +in the region." (let* ((beg (region-beginning)) (end (region-end)) (node (treesit-node-on beg end language)) @@ -1887,13 +1888,10 @@ Return the start of the syntax tree text corresponding to NODE." (defun treesit--explorer-draw-node (node) "Draw the syntax tree of NODE. -If NODE and NODE-HIGHLIGHT are the same node, highlight it. -When this function is called, point should be at an empty line, -when appropriate indent in front of point. When this function -returns, it leaves point at the end of the last line of NODE. - -Return the start position of NODE-HIGHLIGHT in the buffer, if any." +When this function is called, point should be at the position +where the node should start. When this function returns, it +leaves point at the end of the last line of NODE." (let* ((type (treesit-node-type node)) (field-name (treesit-node-field-name node)) (children (treesit-node-children node)) |