; Minor doc fix in treesit.el

* lisp/treesit.el (treesit-outline-search): Mention parameters.
(treesit-major-mode-setup): Mention outline setup.
This commit is contained in:
Yuan Fu 2024-09-14 00:19:47 -07:00
parent 6a6d7925c9
commit 2f243fb91d
No known key found for this signature in database
GPG key ID: 56E19BC57664A442

View 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.