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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#6747: closed (Documentation: `syntax-ppss-toplevel-pos' xref
 typo  `partial-parse-sexp' <- `parse-partial-sexp')
Date: Sun, 01 Aug 2010 00:30:04 +0000

[Message part 1 (text/plain, inline)]

Your message dated Sun, 01 Aug 2010 02:28:23 +0200
with message-id <jwvlj8r89w5.fsf-monnier+emacs <at> gnu.org>
and subject line Re: bug#6747: Documentation: `syntax-ppss-toplevel-pos' xref typo `partial-parse-sexp' <- `parse-partial-sexp'
has caused the GNU bug report #6747,
regarding Documentation: `syntax-ppss-toplevel-pos' xref typo  `partial-parse-sexp' <- `parse-partial-sexp'
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
6747: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=6747
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

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\

[Message part 3 (message/rfc822, inline)]

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: MON KEY <monkey <at> sandpframing.com>
Subject: Re: bug#6747: Documentation: `syntax-ppss-toplevel-pos' xref typo
	`partial-parse-sexp' <- `parse-partial-sexp'
Date: Sun, 01 Aug 2010 02:28:23 +0200

>>>>> "MON" == MON KEY <monkey <at> sandpframing.com> writes:

> 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

Thanks, fixed in the emacs-23 branch,


        Stefan

Previous Next

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