Clarify syntax-ppss doc string

* lisp/emacs-lisp/syntax.el (syntax-ppss): Clarify doc string.

diff --git a/lisp/emacs-lisp/syntax.el b/lisp/emacs-lisp/syntax.el
index 7cc076cd80667c36f1d1e529a46e8343506c2317..a4d7beade135fbe247d715dc4a5d82ba04230706 100644 (file)
--- a/lisp/emacs-lisp/syntax.el
+++ b/lisp/emacs-lisp/syntax.el
@@ -545,10 +545,11 @@ These are valid when the buffer has no restriction.")
 
 (defun syntax-ppss (&optional pos)
   "Parse-Partial-Sexp State at POS, defaulting to point.
+If POS is given, this function moves point to POS.
+
 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
 in the returned list (counting from 0) cannot be relied upon.
-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