unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 37925@debbugs.gnu.org
Subject: bug#37925: 26.3; Elisp manual: add index entry for sets/kinds of variables
Date: Sat, 26 Oct 2019 10:02:26 +0300	[thread overview]
Message-ID: <838sp8vvjx.fsf@gnu.org> (raw)
In-Reply-To: <d6f4fc56-a426-4e0a-8c87-81622f222294@default> (message from Drew Adams on Fri, 25 Oct 2019 12:43:40 -0700 (PDT))

tags 37925 wishlist moreinfo
thanks

> Date: Fri, 25 Oct 2019 12:43:40 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> 
> Please consider adding index entries that correspond directly to these
> node names.  A user should be able to do, for example (and preferably
> with or without the hyphen):
> 
>   i mode-line variables
> 
> Today that's not possible.

Yes, it is possible today, because each variable is indexed by its
name.  So, for example "i mode-line TAB" will show the list of all the
variables (and some other related topics as well).

In general, the technique of working with index entries that I
recommend is to try the text you thought about initially, in this case
"mode-line variables", and if that doesn't bring anything useful,
remove some text from the end and try again, with TAB.  (That is
assuming the above text is something you really thought about in some
real-life use case, and not a synthetic example of no practical
importance.)

Please consider describing use cases where the name of the variable,
or the results of TAB as above, will not let the user arrive to the
place where he or she needs to be.  Otherwise, what you ask for is to
provide one more index entry that begins like many others we already
have and points to the same place, something that is not useful, and
we therefore avoid it.

Thanks.





  reply	other threads:[~2019-10-26  7:02 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-25 19:43 bug#37925: 26.3; Elisp manual: add index entry for sets/kinds of variables Drew Adams
2019-10-26  7:02 ` Eli Zaretskii [this message]
     [not found] <<d6f4fc56-a426-4e0a-8c87-81622f222294@default>
     [not found] ` <<838sp8vvjx.fsf@gnu.org>
2019-10-26 15:41   ` Drew Adams
2019-10-26 16:26     ` 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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=838sp8vvjx.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=37925@debbugs.gnu.org \
    --cc=drew.adams@oracle.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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).