bug#32473: Broken menu entry in manual, section 4.1

bug#32473: Broken menu entry in manual, section 4.1

[HiPhish]

I noticed a broken menu entry in the Info version of the Guix manual: the node 
`Defining Packages` (4.1) has an extra space between the last word and the 
closing colons:

	* package Reference ::	The package data type

The standalone Info reader tolerates it, but not the Info.vim reader, which 
considers the space to be part of the target node name. Neither the Texinfo 
manual (section 4.9) nor the Info manual seem to allow for this extra space, 
so it looks like a bug in the manual to me.

PS: I am the author of the Info.vim reader, if that matters.
https://gitlab.com/HiPhish/info.vim

bug#32473: Broken menu entry in manual, section 4.1

[Ludovic Courtès]

Hello Hiphish,

HiPhish <hiphish@posteo.de> skribis:

> I noticed a broken menu entry in the Info version of the Guix manual: the node 
> `Defining Packages` (4.1) has an extra space between the last word and the 
> closing colons:
>
> 	* package Reference ::	The package data type

Oops, I’ve fixed this now in guix.texi (commit
fa4ebd2f08d0acc25feca827f7e43e8774843a10).

> The standalone Info reader tolerates it, but not the Info.vim reader, which 
> considers the space to be part of the target node name. Neither the Texinfo 
> manual (section 4.9) nor the Info manual seem to allow for this extra space, 
> so it looks like a bug in the manual to me.

Would it make sense for Info.vim to be bug-compatible?

Thanks for your report,
Ludo’.

bug#32473: Broken menu entry in manual, section 4.1

[HiPhish]

On Montag, 20. August 2018 12:21:07 CEST you wrote:
> > The standalone Info reader tolerates it, but not the Info.vim reader,
> > which
> > considers the space to be part of the target node name. Neither the
> > Texinfo
> > manual (section 4.9) nor the Info manual seem to allow for this extra
> > space, so it looks like a bug in the manual to me.
> 
> Would it make sense for Info.vim to be bug-compatible?

I considered that, but I don't think it's a good idea: it's better to fix a 
bug (when feasible of course) than to sweep it under the rug with some hack. 
If the bug is fixed, it's fixed for everyone, if I make Info.vim bug-
compatible I make my reader harder to maintain and that bug still persists and 
will eventually bite someone when they want to implement their own Info 
reader.

bug#32473: Broken menu entry in manual, section 4.1

[Ludovic Courtès]

HiPhish <hiphish@posteo.de> skribis:

> On Montag, 20. August 2018 12:21:07 CEST you wrote:
>> > The standalone Info reader tolerates it, but not the Info.vim reader,
>> > which
>> > considers the space to be part of the target node name. Neither the
>> > Texinfo
>> > manual (section 4.9) nor the Info manual seem to allow for this extra
>> > space, so it looks like a bug in the manual to me.
>> 
>> Would it make sense for Info.vim to be bug-compatible?
>
> I considered that, but I don't think it's a good idea: it's better to fix a 
> bug (when feasible of course) than to sweep it under the rug with some hack. 
> If the bug is fixed, it's fixed for everyone, if I make Info.vim bug-
> compatible I make my reader harder to maintain and that bug still persists and 
> will eventually bite someone when they want to implement their own Info 
> reader.

Yes, that makes a lot of sense to me.  Thanks for your feedback!

Ludo’.