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

Doc amendment for syntax-ppss.

Browse source 
* doc/elisp/syntax.texi (Position Parse): Note, twice, that syntax-ppss is
equivalent to parse-partial-sexp from the beginning of THE VISIBLE PART OF the
buffer.  Final part of the fix for bug #22983.
This commit is contained in:
Alan Mackenzie 2017-10-01 16:08:20 +00:00
parent 98dc91fda8
commit 913808e224
1 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/lispref/syntax.texi
View file

@ -751,7 +751,8 @@ position. This function does that conveniently.
@defun syntax-ppss &optional pos @defun syntax-ppss &optional pos
This function returns the parser state that the parser would reach at This function returns the parser state that the parser would reach at
position @var{pos} starting from the beginning of the buffer. position @var{pos} starting from the beginning of the visible portion
of the buffer.
@iftex @iftex
See the next section for See the next section for
@end iftex @end iftex
@ -762,11 +763,11 @@ for a description of the parser state.
The return value is the same as if you call the low-level parsing The return value is the same as if you call the low-level parsing
function @code{parse-partial-sexp} to parse from the beginning of the function @code{parse-partial-sexp} to parse from the beginning of the
buffer to @var{pos} (@pxref{Low-Level Parsing}). However, visible portion of the buffer to @var{pos} (@pxref{Low-Level
@code{syntax-ppss} uses a cache to speed up the computation. Due to Parsing}). However, @code{syntax-ppss} uses caches to speed up the
this optimization, the second value (previous complete subexpression) computation. Due to this optimization, the second value (previous
and sixth value (minimum parenthesis depth) in the returned parser complete subexpression) and sixth value (minimum parenthesis depth) in
state are not meaningful. the returned parser state are not meaningful.
This function has a side effect: it adds a buffer-local entry to This function has a side effect: it adds a buffer-local entry to
@code{before-change-functions} (@pxref{Change Hooks}) for @code{before-change-functions} (@pxref{Change Hooks}) for