; Minor doc fix in treesit.el
authorYuan Fu <casouri@gmail.com>
Sat, 14 Sep 2024 07:19:47 +0000 (00:19 -0700)
committerYuan Fu <casouri@gmail.com>
Sat, 14 Sep 2024 07:28:23 +0000 (00:28 -0700)
* lisp/treesit.el (treesit-outline-search): Mention parameters.
(treesit-major-mode-setup): Mention outline setup.

lisp/treesit.el

index e0bcbe965c61b6a14a47c026d4df814b73dfe264..270197427773536f34ca48edb031d0d948c6249a 100644 (file)
@@ -2949,7 +2949,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)))
@@ -3058,6 +3059,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.