From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#18092: 24.4.50; doc string of `define-prefix-command' Date: Sat, 30 Apr 2016 00:51:12 +0200 Message-ID: <87shy4kp0f.fsf@gnus.org> References: <59128bf2-e1e4-4f8d-89da-f04a5c31950b@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1461970361 6964 80.91.229.3 (29 Apr 2016 22:52:41 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 29 Apr 2016 22:52:41 +0000 (UTC) Cc: 18092@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Apr 30 00:52:29 2016 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 1awHGv-0006mg-PC for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 00:52:29 +0200 Original-Received: from localhost ([::1]:56693 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awHGr-0006JU-QG for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Apr 2016 18:52:25 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:34324) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awHGi-00065b-SK for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:52:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awHGX-0006Su-6s for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:52:11 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:43811) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awHGX-0006S3-3M for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:52:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1awHGT-00025b-NX for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:52:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 29 Apr 2016 22:52:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 18092 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 18092-submit@debbugs.gnu.org id=B18092.14619702787980 (code B ref 18092); Fri, 29 Apr 2016 22:52:01 +0000 Original-Received: (at 18092) by debbugs.gnu.org; 29 Apr 2016 22:51:18 +0000 Original-Received: from localhost ([127.0.0.1]:56145 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awHFm-00024d-IQ for submit@debbugs.gnu.org; Fri, 29 Apr 2016 18:51:18 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:51724) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awHFk-00024U-Jt for 18092@debbugs.gnu.org; Fri, 29 Apr 2016 18:51:17 -0400 Original-Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1awHFh-0003zK-61; Sat, 30 Apr 2016 00:51:15 +0200 In-Reply-To: <59128bf2-e1e4-4f8d-89da-f04a5c31950b@default> (Drew Adams's message of "Wed, 23 Jul 2014 12:54:39 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.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" Xref: news.gmane.org gmane.emacs.bugs:117290 Archived-At: Drew Adams writes: > Define COMMAND as a prefix command. COMMAND should be a symbol. > A new sparse keymap is stored as COMMAND's function definition and its value. > If a second optional argument MAPVAR is given, the map is stored as > its value instead of as COMMAND's value; but COMMAND is still defined > as a function. > The third optional argument NAME, if given, supplies a menu name > string for the map. This is required to use the keymap as a menu. > This function returns COMMAND. > > 1. It is not at all clear what the occurrence of "its" in the 4th > sentence ("If a second...") refers to. And this part of the doc > string should explicitly say what MAPVAR is: a symbol that is used as > a variable - it is given the map as value. Yes, that's quite unclear. I've now clarified. > 2. The second line of the doc string is too long - should not be more > than 70 chars long. And filled. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no