[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#21594: 25.0.50; (elisp): node `Variable Definitions' is not reachabl

From: Eli Zaretskii
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

> From: Lars Ingebrigtsen <address@hidden>
> Date: Thu, 01 Aug 2019 21:07:48 +0200
> Cc: address@hidden
> > 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 via email to

[Prev in Thread] Current Thread [Next in Thread]