* lisp/emacs-lisp/syntax.el (syntax-ppss): Doc fix.

This commit is contained in:
Xue Fuqiao 2013-10-04 22:46:31 +08:00
parent cd30a8e09c
commit 63bd7f352f
2 changed files with 11 additions and 2 deletions

View 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)