From: Christopher Dimech <dimech@gmx.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 44043-done@debbugs.gnu.org
Subject: bug#44043: Info Files Showing "see" or "*note" when using @ref in source
Date: Sat, 17 Oct 2020 14:40:11 +0200 [thread overview]
Message-ID: <trinity-b50c561b-38e3-48ee-add7-b51dfab7c5b5-1602938411461@3c-app-mailcom-bs14> (raw)
In-Reply-To: <83blh1t6nj.fsf@gnu.org>
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.
>
next prev parent reply other threads:[~2020-10-17 12:40 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-16 21:02 bug#44043: Info Files Showing "see" or "*note" when using @ref in source Christopher Dimech
2020-10-17 4:19 ` Richard Stallman
2020-10-17 8:29 ` Eli Zaretskii
2020-10-17 7:26 ` Eli Zaretskii
2020-10-17 10:47 ` Christopher Dimech
2020-10-17 11:48 ` Eli Zaretskii
2020-10-17 12:40 ` Christopher Dimech [this message]
2020-10-17 12:53 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=trinity-b50c561b-38e3-48ee-add7-b51dfab7c5b5-1602938411461@3c-app-mailcom-bs14 \
--to=dimech@gmx.com \
--cc=44043-done@debbugs.gnu.org \
--cc=eliz@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.