From 913808e224455dc3cd3d7ea0ff5d36849319954a Mon Sep 17 00:00:00 2001 From: Alan Mackenzie Date: Sun, 1 Oct 2017 16:08:20 +0000 Subject: [PATCH] Doc amendment for syntax-ppss. * 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. --- doc/lispref/syntax.texi | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/lispref/syntax.texi b/doc/lispref/syntax.texi index e3ae53536f9..b37f2b22b82 100644 --- a/doc/lispref/syntax.texi +++ b/doc/lispref/syntax.texi @@ -751,7 +751,8 @@ position. This function does that conveniently. @defun syntax-ppss &optional pos 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 See the next section for @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 function @code{parse-partial-sexp} to parse from the beginning of the -buffer to @var{pos} (@pxref{Low-Level Parsing}). However, -@code{syntax-ppss} uses a cache to speed up the computation. Due to -this optimization, the second value (previous complete subexpression) -and sixth value (minimum parenthesis depth) in the returned parser -state are not meaningful. +visible portion of the buffer to @var{pos} (@pxref{Low-Level +Parsing}). However, @code{syntax-ppss} uses caches to speed up the +computation. Due to this optimization, the second value (previous +complete subexpression) and sixth value (minimum parenthesis depth) in +the returned parser state are not meaningful. This function has a side effect: it adds a buffer-local entry to @code{before-change-functions} (@pxref{Change Hooks}) for -- 2.39.5