all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
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, 1 Aug 2019 12:57:15 -0700 (PDT)	[thread overview]
Message-ID: <64e5afff-9f62-4408-bc34-696415d77271@default> (raw)
In-Reply-To: <87v9vgg0vv.fsf@mouse.gnus.org>

> I'm not quite sure what you want to have done here.  As you say, that
> node isn't really about "variable definitions", so it seems like a very
> good thing that "variable definition" doesn't take you there, but to
> "12.5 Defining Global Variables", which makes more sense.

Index entry `variable definition' takes you to 12.5,
and it did previously as well.  That's good, as far
as it goes.

The point of the bug report is this:

Node `Variable Definitions' is misnamed.  It is
only about _option_ definitions.  It does not
correspond to index entry `variable definitions'
(which is a good thing).

The title in the node itself is better: `Defining
Customization Variables'.  Please consider making
a change like that for the node itself (but see
below, for a node name that's arguably better).

(Someone looking for variable definitions, i.e.,
defining variables, and who might, therefore, use
index entry `variable definitions', will not find
anything about user options (`defcustom').

That's unfortunate perhaps, but there's no way
around that if we want a book (a tree, not a graph),
and we want the `defcustom' info to be where it is
now, which makes sense.

At least a user will find a link in node `Defining
Variables', to go to node `Variable Definitions'
for info about `defcustom'.)

The requested change is to the node name of
`Variable Definitions'.  Consider changing it to
`Defining User Options' or `Defining Customization
Variables'.

(But we don't really call them by the latter name.
When we use "variable" instead of "option" for
them we usually say "custom variable" or
"customizable variable".)





  parent reply	other threads:[~2019-08-01 19:57 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
2019-08-01 19:57   ` Drew Adams [this message]
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=64e5afff-9f62-4408-bc34-696415d77271@default \
    --to=drew.adams@oracle.com \
    --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.