From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Andreas Schwab Newsgroups: gmane.emacs.bugs Subject: bug#8935: 24.0.50; `substitute-command-keys' doc Date: Fri, 15 Jul 2011 22:09:46 +0200 Message-ID: References: <7A4E77E7DAE2436DA3DFE76693103500@us.oracle.com> <52B42160EFF24B69AE5BBAC0A0D03346@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: dough.gmane.org 1310761631 19465 80.91.229.12 (15 Jul 2011 20:27:11 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 15 Jul 2011 20:27:11 +0000 (UTC) Cc: 'Lars Magne Ingebrigtsen' , 8935@debbugs.gnu.org To: "Drew Adams" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jul 15 22:27:07 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1QhoyX-000648-1k for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Jul 2011 22:27:05 +0200 Original-Received: from localhost ([::1]:49583 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QhoyV-0008Tv-Lr for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Jul 2011 16:27:03 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:60420) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhoi9-0004se-J8 for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 16:10:13 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Qhoi4-000064-Pn for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 16:10:09 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:48807) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhoi4-0008WS-Cn for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 16:10:04 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1Qhoi3-0006j2-KE; Fri, 15 Jul 2011 16:10:03 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Andreas Schwab Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 15 Jul 2011 20:10:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 8935 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: fixed Original-Received: via spool by 8935-submit@debbugs.gnu.org id=B8935.131076059925840 (code B ref 8935); Fri, 15 Jul 2011 20:10:03 +0000 Original-Received: (at 8935) by debbugs.gnu.org; 15 Jul 2011 20:09:59 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qhohx-0006ii-JN for submit@debbugs.gnu.org; Fri, 15 Jul 2011 16:09:57 -0400 Original-Received: from mail-out.m-online.net ([212.18.0.9]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qhoht-0006iQ-NP for 8935@debbugs.gnu.org; Fri, 15 Jul 2011 16:09:54 -0400 Original-Received: from frontend1.mail.m-online.net (unknown [192.168.8.180]) by mail-out.m-online.net (Postfix) with ESMTP id DB6C61C01DF9; Fri, 15 Jul 2011 22:09:47 +0200 (CEST) Original-Received: from localhost (dynscan1.mnet-online.de [192.168.8.164]) by mail.m-online.net (Postfix) with ESMTP id D22A51C0005B; Fri, 15 Jul 2011 22:09:47 +0200 (CEST) X-Virus-Scanned: amavisd-new at mnet-online.de Original-Received: from mail.mnet-online.de ([192.168.8.180]) by localhost (dynscan1.mail.m-online.net [192.168.8.164]) (amavisd-new, port 10024) with ESMTP id bDNemigfqchT; Fri, 15 Jul 2011 22:09:47 +0200 (CEST) Original-Received: from igel.home (ppp-93-104-144-171.dynamic.mnet-online.de [93.104.144.171]) by mail.mnet-online.de (Postfix) with ESMTP; Fri, 15 Jul 2011 22:09:47 +0200 (CEST) Original-Received: by igel.home (Postfix, from userid 501) id D9AD0CA293; Fri, 15 Jul 2011 22:09:46 +0200 (CEST) X-Yow: What PROGRAM are they watching? In-Reply-To: <52B42160EFF24B69AE5BBAC0A0D03346@us.oracle.com> (Drew Adams's message of "Fri, 15 Jul 2011 12:17:46 -0700") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.3 (gnu/linux) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Fri, 15 Jul 2011 16:10:03 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:49214 Archived-At: "Drew Adams" writes: > Escaping a character means making it act normally, not specially. Only the \ > acts specially, Wrong. > and it does so only when it precedes [, {, etc. Right. And only this is of interest. > It is _enough_ to say that \= escapes a \, preventing it from > introducing a substitution when followed by =, [, etc. No, this is the wrong thing to do. The doc string should say how to produce a value that contains the two character sequences '\=' or '\['. That's the *whole* point of the examples (and these are *examples*, not specification). You don't need '\=' to produce a backslash in the value. So that is useless to say so. A doc string needs to get to the point, not be technically correct. Andreas. -- Andreas Schwab, schwab@linux-m68k.org GPG Key fingerprint = 58CA 54C7 6D53 942B 1756 01D3 44D5 214B 8276 4ED5 "And now for something completely different."