; Update tree-sitter manual

* doc/lispref/positions.texi (List Motion): Replace
treesit-defun-prefer-top-level with treesit-defun-tactic.
This commit is contained in:
Yuan Fu 2023-01-02 14:15:36 -08:00
parent 4ef12cfb1f
commit aef869e74f
No known key found for this signature in database
GPG key ID: 56E19BC57664A442

View file

@ -848,25 +848,14 @@ The value of this variable is a regexp matching the node type of defun
nodes. (For ``node'' and ``node type'', @pxref{Parsing Program Source}.) nodes. (For ``node'' and ``node type'', @pxref{Parsing Program Source}.)
For example, @code{python-mode} sets this variable to a regexp that For example, @code{python-mode} sets this variable to a regexp that
matches either @code{function_definition} or @code{class_definition}. matches either @code{"function_definition"} or @code{"class_definition"}.
@end defvar @end defvar
@defvar treesit-defun-prefer-top-level @defvar treesit-defun-tactic
If this variable is non-@code{nil}, Emacs skips nested defuns, when it This variable determines how does Emacs treat nested defuns. If the
looks for beginning and end of a defun, and prefers to go to the value is @code{top-level}, navigation functions only move across
top-level defun instead. top-level defuns, if the value is @code{nested}, navigation functions
recognize nested defuns.
In some languages, a defun could be nested in another one. By default,
Emacs stops at the first defun it encounters. But if this variable's
value is @code{t}, whenever Emacs finds a defun node, it tries to go
up the parse tree until it finds the top-level defun.
This variable can also be a list of cons cells of the form
@w{@code{(@var{from} . @var{to}))}}, where @var{from} and @var{to} are
regexps matching tree-sitter node types. When Emacs finds a defun
node whose type matches any of the @var{from} regexps in the list, it
then tries to go up the parse tree until it finds a higher-level node
matching the corresponding @var{to} regexp.
@end defvar @end defvar
@node Skipping Characters @node Skipping Characters