all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 29400-done@debbugs.gnu.org
Subject: bug#29400: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors'
Date: Fri, 24 Nov 2017 16:42:39 +0200	[thread overview]
Message-ID: <83a7zbagbk.fsf@gnu.org> (raw)
In-Reply-To: <f03d7e3c-b121-4aad-bc5c-1f4a8fba506f@default> (message from Drew Adams on Wed, 22 Nov 2017 08:50:33 -0800 (PST))

> Date: Wed, 22 Nov 2017 08:50:33 -0800 (PST)
> From: Drew Adams <drew.adams@oracle.com>
> 
> Node `Compiler Errors' seems to be the only place in the Elisp manual
> where we tell users that you can use a vacuous `defvar' (no value) to
> suppress a byte-compiler warning about it not being defined.
> 
> But this node has no index entry - at least none that has the word
> `defvar' in it.  Please add such an entry.

I added some index entries, but I don't understand why you wanted an
index entry with "defvar" in it.  A reader who will look for "defvar"
when they want to find ways of suppressing compiler warnings already
knows that defvar is used for that purpose, so why would they use such
a topic at Info-index's prompt?  That's the opposite of what good
index entries should provide -- they should _lead_ to defvar's
description as the way to suppress warnings when the reader thinks of
"warnings" or some such.

> And please either add the same info (about this use of a vacuous
> `defvar') to node `Defining Variables' or add a cross-reference from
> that node to node `Compiler Errors'.

Done.





  reply	other threads:[~2017-11-24 14:42 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-22 16:50 bug#29400: 26.0; Add Elisp manual index entry for `defvar' to node `Compiler Errors' Drew Adams
2017-11-24 14:42 ` Eli Zaretskii [this message]
     [not found] <<f03d7e3c-b121-4aad-bc5c-1f4a8fba506f@default>
     [not found] ` <<83a7zbagbk.fsf@gnu.org>
2017-11-24 16:54   ` Drew Adams
2017-11-24 17:10     ` Eli Zaretskii
     [not found] <<<f03d7e3c-b121-4aad-bc5c-1f4a8fba506f@default>
     [not found] ` <<<83a7zbagbk.fsf@gnu.org>
     [not found]   ` <<f6b9ee9f-e49a-4d7d-9af8-12fb6f3af11d@default>
     [not found]     ` <<83wp2f8uwr.fsf@gnu.org>
2017-11-24 17:39       ` 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=83a7zbagbk.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=29400-done@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 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.