Re: maint: doc: fix documentation of YYERROR

[Hans Aberg]

On 3 Apr 2012, at 10:47, Akim Demaille wrote:

>> I was thinking about the API, like in
>> http://www.gnu.org/software/guile/manual/guile.html#Initialization
>> Actually, I was looking at the PDF, where it looks like:
>> void * scm_with_guile (void *(*func)(void *), void *data)    [C Function]
> 
> There are special commands in Texinfo to support functions,
> indeed, but here the case is different.
> 
> I may "cheat" with Texinfo and let it think that "return" is
> the return type, and the ";" are the arguments:

Ideally, Texinfo might be need some changes, but I'm not sure it is being 
developed.

> address@hidden {Statement} {return YYERROR;}
> address@hidden {Statement} {return} YYERROR ;
> Start error recovery (without printing an error message).
> @xref{Error Recovery}.
> address@hidden deffn
> address@hidden deftypefn
> 
> The result is not as nice looking:
...
> But at least that fixes the index:

The extra space between YYERROR and ';' looks a bit unusual at first, but may 
in fact be OK as a form of emphasis. It fixes the index though, and that might 
be the best possible with the current Texinfo.

> Any preferred solution?

Having the syntax in the subject may be helpful, as one then does not have to 
scan the text body definition for it. Otherwise, probably just a preference.

Hans