all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: 21594@debbugs.gnu.org
Subject: bug#21594: 25.0.50; (elisp): node `Variable Definitions' is not reachable by `i variable definition'
Date: Thu, 01 Aug 2019 22:23:41 +0300	[thread overview]
Message-ID: <83k1bwhepu.fsf@gnu.org> (raw)
In-Reply-To: <87v9vgg0vv.fsf@mouse.gnus.org> (message from Lars Ingebrigtsen on Thu, 01 Aug 2019 21:07:48 +0200)

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Date: Thu, 01 Aug 2019 21:07:48 +0200
> Cc: 21594@debbugs.gnu.org
> 
> > The problem is more the node name than the index entry.  The node title,
> > within the node, is `Defining Customization Variables', which is much
> > better.
> >
> > I imagine that the node name was picked because the node is a subnode of
> > node `Customization', but that is not a good enough reason.
> > `Info-goto-node' handles the nodes of a manual in a flat way.
> >
> > A node named `Variable Definitions' should cover all of defvar,
> > defconst, and defcustom.  Likewise, an index entry named `variable
> > definition'.  IOW, someone hunting for info about variable definitions
> > should be able to get to general info about all kinds of variable
> > definitions.
> 
> I'm not quite sure what you want to have done here.

I think this report simply reads too much into the name of a node.  A
node's name is a label, and needs to satisfy several requirements, so
it isn't always as accurate as the section name.

I don't think we need to do anything about this issue.  There's no
real problem here.  There are several index entries leading to this
node that readers could use, and the assumption that someone might
look up this node by its name, or be surprised that only defcustoms
are described there, is misguided, IMO.





  reply	other threads:[~2019-08-01 19:23 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-09-30 21:46 bug#21594: 25.0.50; (elisp): node `Variable Definitions' is not reachable by `i variable definition' Drew Adams
2019-08-01 19:07 ` Lars Ingebrigtsen
2019-08-01 19:23   ` Eli Zaretskii [this message]
2019-08-01 19:57   ` Drew Adams
2019-08-03  2:19     ` Richard Stallman
2019-08-03  4:45       ` Drew Adams
2019-08-04  2:58         ` Richard Stallman
     [not found] <<ae6720ed-ad9d-4110-9213-c8abdafa81e6@default>
     [not found] ` <<87v9vgg0vv.fsf@mouse.gnus.org>
     [not found]   ` <<83k1bwhepu.fsf@gnu.org>
2019-08-01 20:07     ` Drew Adams
2019-08-02  6:46       ` Eli Zaretskii
2019-08-02 11:25         ` Lars Ingebrigtsen
     [not found] <<<ae6720ed-ad9d-4110-9213-c8abdafa81e6@default>
     [not found] ` <<<87v9vgg0vv.fsf@mouse.gnus.org>
     [not found]   ` <<<83k1bwhepu.fsf@gnu.org>
     [not found]     ` <<02aef894-7fda-4061-943e-24115490c85e@default>
     [not found]       ` <<83d0hogj3i.fsf@gnu.org>
2019-08-02 15:21         ` Drew Adams

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=83k1bwhepu.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=21594@debbugs.gnu.org \
    --cc=larsi@gnus.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.