]> git.eshelyaron.com Git - emacs.git/commitdiff
; Minor doc fix in treesit.el
authorYuan Fu <casouri@gmail.com>
Sat, 14 Sep 2024 07:19:47 +0000 (00:19 -0700)
committerEshel Yaron <me@eshelyaron.com>
Sat, 14 Sep 2024 20:33:50 +0000 (22:33 +0200)
* lisp/treesit.el (treesit-outline-search): Mention parameters.
(treesit-major-mode-setup): Mention outline setup.

(cherry picked from commit 2f243fb91d6d2c4c4e4a6dbbd94ef5b13d543732)

lisp/treesit.el

index a16f7deab60dcda17c154570a5021469b119c9cb..6a066ebd9c6d99452e8fbd6fc45696ad9d51a8b6 100644 (file)
@@ -2934,7 +2934,8 @@ when a major mode sets it.")
 
 (defun treesit-outline-search (&optional bound move backward looking-at)
   "Search for the next outline heading in the syntax tree.
-See the descriptions of arguments in `outline-search-function'."
+For BOUND, MOVE, BACKWARD, LOOKING-AT, see the descriptions in
+`outline-search-function'."
   (if looking-at
       (when-let* ((node (or (treesit-thing-at (pos-eol) treesit-outline-predicate)
                             (treesit-thing-at (pos-bol) treesit-outline-predicate)))
@@ -3043,6 +3044,10 @@ If `treesit-defun-name-function' is non-nil, set up
 
 If `treesit-simple-imenu-settings' is non-nil, set up Imenu.
 
+If `treesit-outline-predicate' or `treesit-simple-imenu-settings', and
+Outline minor mode settings don't alreay exist, setup Outline minor
+mode.
+
 If `sexp', `sentence' are defined in `treesit-thing-settings',
 enable tree-sitter navigation commands for them.