all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Christopher Dimech <dimech@gmx.com>
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:48:32 +0300	[thread overview]
Message-ID: <83blh1t6nj.fsf@gnu.org> (raw)
In-Reply-To: <trinity-dc6f3d64-e623-46f7-9c79-28338bec6515-1602931637626@3c-app-mailcom-bs14> (message from Christopher Dimech on Sat, 17 Oct 2020 12:47:17 +0200)

> 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.





  reply	other threads:[~2020-10-17 11:48 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 [this message]
2020-10-17 12:40       ` Christopher Dimech
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=83blh1t6nj.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=44043-done@debbugs.gnu.org \
    --cc=dimech@gmx.com \
    /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.