bug#44043: Info Files Showing "see" or "*note" when using @ref in source

[Christopher Dimech]

Yes, in the manual it can ignore the variable and not document every single
thing, but when a defaulted variable changes the output of what is expected
from the official texinfo behaviour, some documentation is required, as it
was.  Simply involved a little update, and a bit more clarity in description.

Regards
Christopher


---------------------
Christopher Dimech
Administrator - Naiad Informatics - GNU Project (Geocomputation)
- Geophysical Simulation
- Geological Subsurface Mapping
- Disaster Preparedness and Mitigation
- Natural Resource Exploration and Production
- Free Software Advocacy


> Sent: Saturday, October 17, 2020 at 1:48 PM
> From: "Eli Zaretskii" <eliz@gnu.org>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: 44043-done@debbugs.gnu.org
> Subject: Re: bug#44043: Info Files Showing "see" or "*note" when using @ref 
> in source
>
> > From: Christopher Dimech <dimech@gmx.com>
> > Cc: 44043@debbugs.gnu.org
> > Date: Sat, 17 Oct 2020 12:47:17 +0200
> >
> > The Emacs Manual does not mention hide so did not try it.  Now
> > that I have, the problem is resolved.  The Emacs Manual needs
> > to be updated as the option is not described. It only describes
> > "t" and "nil". Here are the sections concerned:
> >
> > 1.5 Invisible text in Emacs Info
> > 1.7 Following Cross-References
> > 2.6 Emacs Info-mode Variables
>
> You mean, the Info mode manual, not the Emacs manual.
>
> I fixed the last one of these 3 sections, as only it includes the full
> description of the variable, and the other two only discuss limited
> effects of the variable.
>
> > Using M-x describe-variable <Ret> Info-hide-note-references,
> > although if would help with an improved documentation.
>
> Indeed, the doc string of a variable is the recommended place to look
> first for the details of the variable.  The manual could provide some
> background and more elaborate info, but it could also completely
> ignore the variable (we don't document every variable and every
> function in our manuals).
>
> With that, I'm closing this bug report.  Thanks.
>