* lisp/emacs-lisp/syntax.el (syntax-ppss): Doc fix.
authorXue Fuqiao <xfq.free@gmail.com>
Fri, 4 Oct 2013 14:46:31 +0000 (22:46 +0800)
committerXue Fuqiao <xfq.free@gmail.com>
Fri, 4 Oct 2013 14:46:31 +0000 (22:46 +0800)
lisp/ChangeLog
lisp/emacs-lisp/syntax.el

index bb4b89a..ecf943e 100644 (file)
@@ -1,3 +1,7 @@
+2013-10-04  Xue Fuqiao  <xfq.free@gmail.com>
+
+       * emacs-lisp/syntax.el (syntax-ppss): Doc fix.
+
 2013-10-04  Michael Albinus  <michael.albinus@gmx.de>
 
        * net/secrets.el (secrets-create-collection): Add optional
index 3e85032..6b169d3 100644 (file)
@@ -405,9 +405,14 @@ point (where the PPSS is equivalent to nil).")
 (defun syntax-ppss (&optional pos)
   "Parse-Partial-Sexp State at POS, defaulting to point.
 The returned value is the same as that of `parse-partial-sexp'
-run from point-min to POS except that values at positions 2 and 6
+run from `point-min' to POS except that values at positions 2 and 6
 in the returned list (counting from 0) cannot be relied upon.
-Point is at POS when this function returns."
+Point is at POS when this function returns.
+
+It is necessary to call `syntax-ppss-flush-cache' explicitly if
+this function is called while `before-change-functions' is
+temporarily let-bound, or if the buffer is modified without
+running the hook."
   ;; Default values.
   (unless pos (setq pos (point)))
   (syntax-propertize pos)