GNU bug report logs - #6747
Documentation: `syntax-ppss-toplevel-pos' xref typo `partial-parse-sexp' <- `parse-partial-sexp'

Previous Next

Full log

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: MON KEY <monkey <at> sandpframing.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Documentation: `syntax-ppss-toplevel-pos' xref typo 
	`partial-parse-sexp' <- `parse-partial-sexp'
Date: Wed, 28 Jul 2010 11:16:13 -0400

The function `syntax-ppss-toplevel-pos' in emacs-lisp/syntax.el appears to
have a type:

,---- (documentation 'syntax-ppss-toplevel-pos)
|
| Get the latest syntactically outermost position found in a syntactic scan.
| PPSS is a scan state, as returned by `partial-parse-sexp' or `syntax-ppss'.
| An "outermost position" means one that it is outside of any syntactic entity:
| outside of any parentheses, comments, or strings encountered in the scan.
| If no such position is recorded in PPSS (because the end of the scan was
| itself at the outermost level), return nil.
|
`----

Is the second line in error? e.g.

"PPSS is a scan state, as returned by `partial-parse-sexp' or `syntax-ppss'."
                                       ^^^^^^^^^^^^^^^^^^

Shouldn't that be `parse-partial-sexp'?

Appears with docstring current through bzr-100920

--
/s_P\

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.