From: Yuan Fu <casouri@gmail.com>
Date: Sat, 14 Sep 2024 07:19:47 +0000 (-0700)
Subject: ; Minor doc fix in treesit.el
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=1d0a76d211dd9df50e8b14bcffb6c9fa37337996;p=emacs.git

; Minor doc fix in treesit.el

* lisp/treesit.el (treesit-outline-search): Mention parameters.
(treesit-major-mode-setup): Mention outline setup.

(cherry picked from commit 2f243fb91d6d2c4c4e4a6dbbd94ef5b13d543732)
---

diff --git a/lisp/treesit.el b/lisp/treesit.el
index a16f7deab60..6a066ebd9c6 100644
--- a/lisp/treesit.el
+++ b/lisp/treesit.el
@@ -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.