procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Fix documentation of recent commits related to treesit

Browse source 
* src/treesit.c (Ftreesit_parser_changed_ranges):
* doc/lispref/parsing.texi (Using Parser): Fix wording.
This commit is contained in:
Eli Zaretskii 2024-04-20 09:53:35 +03:00
parent 71d2ec7aba
commit 42776dc5b7
2 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/lispref/parsing.texi
View file

@ -539,10 +539,10 @@ symbol, rather than a lambda function.
This function returns the list of @var{parser}'s notifier functions.
@end defun
Sometimes a user might want to synchronously get the changed ranges of
the last reparse, and @code{treesit-parser-changed-ranges} is just for
it. This function basically returns the @var{ranges} that the notifier
functions were passed.
Sometimes a Lisp program might need to synchronously get the changed
ranges of the last reparse. The function
@code{treesit-parser-changed-ranges} exists for this purpose. It
returns the ranges which were passed to the notifier functions.
@defun treesit-parser-changed-ranges parser &optional quiet
This function returns the ranges that has been changed since last
@ -552,8 +552,8 @@ mark the start and the end positions of a range.
This function should almost always be called immediately after
reparsing. If it's called when there are new buffer edits that hasn't
been reparsed, Emacs signals @code{treesit-unparsed-edits}, unless
@var{quiet} is non-nil.
been reparsed, Emacs signals the @code{treesit-unparsed-edits} error,
unless the optional argument @var{quiet} is non-nil.
Calling this function multiple times consecutively doesn't change its
return value; it always returns the ranges affected by the last reparse.

8
src/treesit.c
View file

@ -1833,13 +1833,13 @@ DEFUN ("treesit-parser-changed-ranges", Ftreesit_parser_changed_ranges,
1, 2, 0,
doc: /* Return the buffer regions affected by the last reparse of PARSER.
Returns a list of cons (BEG . END), where each cons represents a region
in which the buffer content was affected by the last reparse.
Returns a list of cons cells (BEG . END), where each cons cell represents
a region in which changes in buffer contents affected the last reparse.
This function should almost always be called immediately after
reparsing. If it's called when there are new buffer edits that hasn't
been reparsed, Emacs signals `treesit-unparsed-edits', unless QUIET is
non-nil.
been reparsed, Emacs signals the `treesit-unparsed-edits' error, unless
optional argument QUIET is non-nil.
Calling this function multiple times consecutively doesn't change its
return value; it always returns the ranges affected by the last