Re: State argument of `parse-partial-sexp'

[Stefan Monnier]

> Elisp manual and doc-string of `parse-partial-sexp' imply that the 8th
> and 9th element are not needed (can be omitted) in the state argument.
> I think they are needed.  Hence, I propose the following patches:

Good point.  While you're there, do in the manual as is done in the
docstring:
- don't specify the length of the state argument: just say it's the same as
  the return value.
- specify the ignored elements rather than the non-ignored ones.
  The list of ignored ones is much less likely to change.


        Stefan


> 2006-05-15  Martin Rudalics  <address@hidden>

>       * syntax.texi (Parsing Expressions): Fix description of
>       `parse-partial-sexp'.

> *** syntax.texi       Mon May  1 10:08:56 2006
> --- syntax.texi       Mon May 15 11:04:44 2006
> ***************
> *** 661,670 ****
>   string, or the end of a comment or a string, whichever comes first.

>   @cindex parse state
> ! The fifth argument @var{state} is a ten-element list of the same form
> ! as the value of this function, described below.  (It is OK to omit the
> ! last two elements of this list.)  The return value of one call may be
> ! used to initialize the state of the parse on another call to
>   @code{parse-partial-sexp}.

>   The result is a list of ten elements describing the final state of
> --- 661,669 ----
>   string, or the end of a comment or a string, whichever comes first.

>   @cindex parse state
> ! The fifth argument @var{state} is a ten-element list of the same form as
> ! the value of this function, described below.  The return value of one
> ! call may be used to initialize the state of the parse on another call to
>   @code{parse-partial-sexp}.

>   The result is a list of ten elements describing the final state of
> ***************
> *** 724,730 ****

>   @end enumerate

> ! Elements 0, 3, 4, 5, 7 and 9 are significant in the argument
>   @var{state}.

>   @cindex indenting with parentheses
> --- 723,729 ----

>   @end enumerate

> ! Elements 0, 3, 4, 5, 7, 8 and 9 are significant in the argument
>   @var{state}.

>   @cindex indenting with parentheses


> 2006-05-15  Martin Rudalics  <address@hidden>

>       * syntax.c (`parse-partial-sexp'): Fix doc-string.

> *** syntax.c  Mon May  1 10:08:58 2006
> --- syntax.c  Mon May 15 11:06:54 2006
> ***************
> *** 3043,3050 ****
>   Fourth arg STOPBEFORE non-nil means stop when come to
>    any character that starts a sexp.
>   Fifth arg OLDSTATE is a list like what this function returns.
> !  It is used to initialize the state of the parse.  Elements number 1, 2, 6
> !  and 8 are ignored; you can leave off element 8 (the last) entirely.
>   Sixth arg COMMENTSTOP non-nil means stop at the start of a comment.
>    If it is symbol `syntax-table', stop after the start of a comment or a
>    string, or after end of a comment or a string.  */)
> --- 3043,3050 ----
>   Fourth arg STOPBEFORE non-nil means stop when come to
>    any character that starts a sexp.
>   Fifth arg OLDSTATE is a list like what this function returns.
> !  It is used to initialize the state of the parse.  Elements number 1, 2,
> !  and 6 are ignored.
>   Sixth arg COMMENTSTOP non-nil means stop at the start of a comment.
>    If it is symbol `syntax-table', stop after the start of a comment or a
>    string, or after end of a comment or a string.  */)


> _______________________________________________
> Emacs-devel mailing list
> address@hidden
> http://lists.gnu.org/mailman/listinfo/emacs-devel