Re: maint: doc: fix documentation of YYERROR

[Akim Demaille]

Le 2 avr. 2012 à 18:46, Hans Aberg a écrit :

> On 2 Apr 2012, at 16:57, Akim Demaille wrote:
> 
>> What do you think we should do about this?
>> - leave as is
>> - factor the @def macros to all use no `;'
>> - try to keep the `;' in the core of the text,
>> but have it appear without the `;' in the Index.
> 
> 
> You might use the style of the Guile 2.x manual. In the index, only the name 
> is given. In the definition, the syntax is given, with a text body 
> explanation.

I'm not sure I see what you mean.  For instance in the documentation
of Java, Paolo wrote this:

@deffn {Statement} {return YYABORT;}
Return immediately from the parser, indicating failure.
@xref{Java Parser Interface}.
@end deffn

@deffn {Statement} {return YYACCEPT;}
Return immediately from the parser, indicating success.
@xref{Java Parser Interface}.
@end deffn

@deffn {Statement} {return YYERROR;}
Start error recovery without printing an error message.
@xref{Error Recovery}.
@end deffn

It makes plenty of sense when reading the generated file, but
the index is very wrong.  In guile, AFAICS, they just specify
the arguments, which we also know how to do.

Unless you can point me to an example in
http://www.gnu.org/software/guile/manual/guile.html of where
you think they address this.