unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Chong Yidong'" <cyd@gnu.org>
Cc: 13219@debbugs.gnu.org
Subject: bug#13219: 24.3.50; missing `...' in Emacs manual
Date: Fri, 21 Dec 2012 00:24:21 -0800	[thread overview]
Message-ID: <4D17A9193B6E4B82A8F138631D887384@us.oracle.com> (raw)
In-Reply-To: <87k3sbhloq.fsf@gnu.org>

[-- Attachment #1: Type: text/plain, Size: 1073 bytes --]

> > There are still some missing `...' in the Emacs manual.  See node
> > `Keys', for instance.  Each key sequence is correctly quoted there,
> > except for these: `<F1>', `<F2>', `<ESC>'.  `<ESC> C-h' is
> > correctly quoted, but `<ESC>' is not quoted, though it should be.
> 
> It is the convention in the manual not to insert `..' around single
> function keys which are already printed like <this>.  Not a 
> bug (and no bike-shedding please).

See attached screenshot.  Are you perhaps trying to make a virtue (and a
convention) out of mistake?  Do you honestly think it is more readable to have
these exceptions?

If you want to get rid of unnecessary wrappers, and have consistency at the same
time, then get rid of the angle brackets.  They serve no purpose whatsoever, as
I've demonstrated before (and can again).

I can even give you the code to get rid of them from the product altogether (not
the doc), with the exception of the C code for `substitute-command-keys', which
someone else will need to patch.  Better: I can give you code that makes them
optional.

[-- Attachment #2: throw-unquoted-keys.png --]
[-- Type: image/png, Size: 8647 bytes --]

  reply	other threads:[~2012-12-21  8:24 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-12-18 14:27 bug#13219: 24.3.50; missing `...' in Emacs manual Drew Adams
2012-12-21  8:08 ` Chong Yidong
2012-12-21  8:24   ` Drew Adams [this message]
2012-12-21  9:22     ` Eli Zaretskii
2012-12-21 16:49       ` Drew Adams
2012-12-21 17:10       ` Stephen Berman
2012-12-21 17:31         ` 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

  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=4D17A9193B6E4B82A8F138631D887384@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=13219@debbugs.gnu.org \
    --cc=cyd@gnu.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 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).