[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Recent changes in parsing.texi
From: |
Yuan Fu |
Subject: |
Re: Recent changes in parsing.texi |
Date: |
Sun, 25 Dec 2022 00:27:18 -0800 |
> On Dec 24, 2022, at 11:30 PM, Eli Zaretskii <eliz@gnu.org> wrote:
>
> There seems to be something missing in the new text:
>
> +@defun treesit-defun-at-point
> +This function returns the defun node at point, or @code{nil} if none
> +is found. It respects @code{treesit-defun-tactic}: it returns the
> +top-level defun if the value is @code{top-level}, and returns the
> +immediate enclosing defun if the value is @code{nested}.
>
> This mentions treesit-defun-tactic, but that variable is not
> documented anywhere in the manual, and is not indexed. It should
> either be documented in this node, or in some other node with a
> cross-reference from here to that other node.
I'll add a FIXME to remind myself to add a cross reference when we add the user
manual. I think this variable should be in the user manual since its a user
configuration. (I have a list of things that should be mentioned in the user
manual.)
>
> In general, please remember to index every function, macro, face, and
> variable unless they are in @defun/@defvar/@defmac etc., which add
> index entries automatically.
I’ll keep that in mind!
Yuan