aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlan Mackenzie2017-10-01 16:08:20 +0000
committerAlan Mackenzie2017-10-01 16:08:20 +0000
commit913808e224455dc3cd3d7ea0ff5d36849319954a (patch)
tree5d016c5181d49482ebddf0d72d9ce1dcb34ed8bf
parent98dc91fda8d81e6b51e71fd4a034f6cb87537d52 (diff)
downloademacs-913808e224455dc3cd3d7ea0ff5d36849319954a.tar.gz
emacs-913808e224455dc3cd3d7ea0ff5d36849319954a.zip
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.
-rw-r--r--doc/lispref/syntax.texi13
1 files 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.
751 751
752@defun syntax-ppss &optional pos 752@defun syntax-ppss &optional pos
753This function returns the parser state that the parser would reach at 753This function returns the parser state that the parser would reach at
754position @var{pos} starting from the beginning of the buffer. 754position @var{pos} starting from the beginning of the visible portion
755of the buffer.
755@iftex 756@iftex
756See the next section for 757See the next section for
757@end iftex 758@end iftex
@@ -762,11 +763,11 @@ for a description of the parser state.
762 763
763The return value is the same as if you call the low-level parsing 764The return value is the same as if you call the low-level parsing
764function @code{parse-partial-sexp} to parse from the beginning of the 765function @code{parse-partial-sexp} to parse from the beginning of the
765buffer to @var{pos} (@pxref{Low-Level Parsing}). However, 766visible portion of the buffer to @var{pos} (@pxref{Low-Level
766@code{syntax-ppss} uses a cache to speed up the computation. Due to 767Parsing}). However, @code{syntax-ppss} uses caches to speed up the
767this optimization, the second value (previous complete subexpression) 768computation. Due to this optimization, the second value (previous
768and sixth value (minimum parenthesis depth) in the returned parser 769complete subexpression) and sixth value (minimum parenthesis depth) in
769state are not meaningful. 770the returned parser state are not meaningful.
770 771
771This function has a side effect: it adds a buffer-local entry to 772This function has a side effect: it adds a buffer-local entry to
772@code{before-change-functions} (@pxref{Change Hooks}) for 773@code{before-change-functions} (@pxref{Change Hooks}) for