From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs Subject: bug#14199: 24.3.50; `read-kbd-macro' doc Date: Sat, 13 Apr 2013 10:49:04 -0700 Message-ID: <7A6B3EA5F62D48D291D7E316EF83AB17@us.oracle.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1365875406 1551 80.91.229.3 (13 Apr 2013 17:50:06 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 13 Apr 2013 17:50:06 +0000 (UTC) To: 14199@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Apr 13 19:50:09 2013 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1UR4aV-0000DL-6Y for geb-bug-gnu-emacs@m.gmane.org; Sat, 13 Apr 2013 19:50:07 +0200 Original-Received: from localhost ([::1]:44953 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UR4aU-0007Ts-Pb for geb-bug-gnu-emacs@m.gmane.org; Sat, 13 Apr 2013 13:50:06 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:51938) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UR4aQ-0007RN-Vb for bug-gnu-emacs@gnu.org; Sat, 13 Apr 2013 13:50:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UR4aP-0002ZF-T1 for bug-gnu-emacs@gnu.org; Sat, 13 Apr 2013 13:50:02 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:44850) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UR4aP-0002Ur-Pd for bug-gnu-emacs@gnu.org; Sat, 13 Apr 2013 13:50:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1UR4eI-0005Lw-Eu for bug-gnu-emacs@gnu.org; Sat, 13 Apr 2013 13:54:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 13 Apr 2013 17:54:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 14199 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: Original-Received: via spool by submit@debbugs.gnu.org id=B.136587560820525 (code B ref -1); Sat, 13 Apr 2013 17:54:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 13 Apr 2013 17:53:28 +0000 Original-Received: from localhost ([127.0.0.1]:48958 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UR4dj-0005L0-Fu for submit@debbugs.gnu.org; Sat, 13 Apr 2013 13:53:27 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:40396) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UR4dg-0005Ko-Dk for submit@debbugs.gnu.org; Sat, 13 Apr 2013 13:53:25 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UR4Zk-00029P-WB for submit@debbugs.gnu.org; Sat, 13 Apr 2013 13:49:22 -0400 Original-Received: from lists.gnu.org ([208.118.235.17]:54448) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UR4Zk-00029K-Sl for submit@debbugs.gnu.org; Sat, 13 Apr 2013 13:49:20 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:51747) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UR4Zj-0007OO-7t for bug-gnu-emacs@gnu.org; Sat, 13 Apr 2013 13:49:20 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UR4Zi-00028k-DW for bug-gnu-emacs@gnu.org; Sat, 13 Apr 2013 13:49:19 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:33798) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UR4Zi-00028e-6l for bug-gnu-emacs@gnu.org; Sat, 13 Apr 2013 13:49:18 -0400 Original-Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by aserp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id r3DHnGbp020174 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Sat, 13 Apr 2013 17:49:17 GMT Original-Received: from aserz7022.oracle.com (aserz7022.oracle.com [141.146.126.231]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r3DHnF2Z013032 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL) for ; Sat, 13 Apr 2013 17:49:16 GMT Original-Received: from abhmt112.oracle.com (abhmt112.oracle.com [141.146.116.64]) by aserz7022.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r3DHnFWZ013028 for ; Sat, 13 Apr 2013 17:49:15 GMT Original-Received: from dradamslap1 (/71.202.147.44) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sat, 13 Apr 2013 10:49:14 -0700 X-Mailer: Microsoft Office Outlook 11 Thread-Index: Ac44bzCYktdTYO8tThesl5TdBTgKfQ== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: acsinet22.oracle.com [141.146.126.238] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x 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:73382 Archived-At: In (elisp) `Describing Characters', description of `read-kbd-macro': 1. The signature and description are incorrect/incomplete. According to the source code and the doc string, the signature is (read-kbd-macro START &optional END). The doc string shows the correct signature, and it is clearer than the manual wrt the signature and the possibility of passing STRING and NEED-VECTOR instead. The manual needs to clearly point out that there are, in effect, two different signatures, even if one is considered primary. Each needs to be documented. So do not remove the existing description about STRING and NEED-VECTOR. Instead, supplement it with a description of the other signature and its behavior. 2. Mention that STRING has the form provided by `format-kbd-macro'. `format-kbd-macro' is mentioned nowhere in the manual, and this is a good place for it. In GNU Emacs 24.3.50.1 (i386-mingw-nt5.1.2600) of 2013-04-09 on ODIEONE Bzr revision: 112253 rgm@gnu.org-20130409101736-f1vzgrwt88suqqis Windowing system distributor `Microsoft Corp.', version 5.1.2600 Configured using: `configure --with-gcc (4.7) --no-opt --enable-checking --cflags -IC:/Devel/emacs/build/include --ldflags -LC:/Devel/emacs/build/lib'