unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Michael Albinus <michael.albinus@gmx.de>
Cc: emacs-devel@gnu.org
Subject: Re: emacs-26 b90e91c: Fix last change of @key markup
Date: Thu, 01 Feb 2018 21:39:45 +0200	[thread overview]
Message-ID: <83efm4eby6.fsf@gnu.org> (raw)
In-Reply-To: <877erwpmvb.fsf@gmx.de> (message from Michael Albinus on Thu, 01 Feb 2018 19:48:24 +0100)

> From: Michael Albinus <michael.albinus@gmx.de>
> Cc: Eli Zaretskii <eliz@gnu.org>
> Date: Thu, 01 Feb 2018 19:48:24 +0100
> 
> for future changes I might apply, could you pls tell me what was wrong
> with my changes?

@key is only for names of keys, not for names of characters or
commands.  Your changes to add @key were mostly good, but they went a
notch too far, in that they included _any_ instance of "TAB" or "RET"
or "SPC", including, for example, this:

  @item big-indent
  @vindex whitespace-big-indent-regexp
  Highlight too-deep indentation.  By default any sequence of at least 4
  consecutive TAB characters or 32 consecutive SPC characters is
  highlighted.  To change that, customize the regular expression

Here, TAB and SPC refer to characters, not keys.

If that still doesn't make the criterion clear, consider this: the
purpose of @key is to avoid the erroneous interpretation of "RET" to
mean literal 3 characters R E T.  And such an erroneous interpretation
can only happen in the context of describing keyboard input or keys
the user presses, it cannot happen when the text refers to characters,
as in the above excerpt.  (Another way of looking at this is to see
how TeX renders @key: the result looks like a key on a keyboard, and
that is, of course, inappropriate when talking about anything other
than a keyboard key.)

HTH



  reply	other threads:[~2018-02-01 19:39 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20180201175714.3571.11628@vcs0.savannah.gnu.org>
     [not found] ` <20180201175715.624202068E@vcs0.savannah.gnu.org>
2018-02-01 18:48   ` emacs-26 b90e91c: Fix last change of @key markup Michael Albinus
2018-02-01 19:39     ` Eli Zaretskii [this message]
2018-02-02  2:12     ` Richard Stallman

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=83efm4eby6.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=michael.albinus@gmx.de \
    /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).