unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Noam Postavsky <npostavs@gmail.com>
Cc: 31623@debbugs.gnu.org
Subject: bug#31623: 27.0; Elisp manual, index entry "; in comment"
Date: Tue, 29 May 2018 19:23:12 -0700 (PDT)	[thread overview]
Message-ID: <768edb20-d1d3-4c9b-9f44-4c17a8df8e41@default> (raw)
In-Reply-To: <871sdtdhvx.fsf@gmail.com>

> >> > If that's the intention then I think it might be clearer
> >> > if the index entry were "; outside a comment" or maybe
> >> > "; not in a comment".
> 
> > But certainly the `;' that starts a comment is part of the
> > comment itself.  No one would doubt that, I think.
> 
> I'm a bit puzzled then.  How would "; outside a comment" make sense for
> a page which talks about comments?  That seems to be the opposite of
> what it's about.

That's not a great index entry either.  The target text
is not at all about `;' in text that is commented.  It
is only about `;' used as a comment-start char.

> > The entry should indicate something about the subject
> > indexed.  "; in comment" does not do that, for me, at
> > least.
> 
> What do you think about the "(...) in lists" entry?

Never noticed it.  At least it's not a character.

If I had to guess naively, I'd probably expect that to
take me to some text about nested lists.  IMO, it too
is a bad index entry.  It's not clear at all what someone
might be looking for who would find that a description
that might help her find what is sought.

> > Or perhaps you have a suggestion.
> 
> I don't really see a problem with the current one, but I guess "; for
> commenting" (in the same vein as "' for quoting") could be okay.





  reply	other threads:[~2018-05-30  2:23 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-28 14:35 bug#31623: 27.0; Elisp manual, index entry "; in comment" Drew Adams
2018-05-29 23:32 ` Noam Postavsky
2018-05-29 23:47   ` Drew Adams
2018-05-30  0:14     ` Noam Postavsky
2018-05-30  0:38       ` Drew Adams
2018-05-30  1:58         ` Noam Postavsky
2018-05-30  2:23           ` Drew Adams [this message]
2018-06-20 12:48           ` Noam Postavsky

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=768edb20-d1d3-4c9b-9f44-4c17a8df8e41@default \
    --to=drew.adams@oracle.com \
    --cc=31623@debbugs.gnu.org \
    --cc=npostavs@gmail.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).