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:54:39 +0200 Message-ID: <87mvockouo.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 1461970543 9460 80.91.229.3 (29 Apr 2016 22:55:43 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 29 Apr 2016 22:55:43 +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:55:32 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 1awHJr-00089H-CO for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 00:55:31 +0200 Original-Received: from localhost ([::1]:56701 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awHJn-0001hL-PG for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Apr 2016 18:55:27 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:35802) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awHJd-0001PT-TR for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:55:24 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awHJS-00089a-2E for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:55:12 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:43822) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awHJR-00086Y-VX for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:55:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1awHJO-0002AM-J3 for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 18:55:02 -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:55:02 +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.14619704848280 (code B ref 18092); Fri, 29 Apr 2016 22:55:02 +0000 Original-Received: (at 18092) by debbugs.gnu.org; 29 Apr 2016 22:54:44 +0000 Original-Received: from localhost ([127.0.0.1]:56155 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awHJ6-00029U-AV for submit@debbugs.gnu.org; Fri, 29 Apr 2016 18:54:44 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:51751) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awHJ4-00029L-U1 for 18092@debbugs.gnu.org; Fri, 29 Apr 2016 18:54:43 -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 1awHJ2-000416-08; Sat, 30 Apr 2016 00:54:41 +0200 In-Reply-To: (Drew Adams's message of "Wed, 23 Jul 2014 13:16:50 -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:117292 Archived-At: Drew Adams writes: > Things are actually worse than that. > > The notion of "prefix command" is not introduced or explained anywhere. > It is not in either the Emacs manual or the Elisp manual. > > `define-prefix-command' has been around for a long time, but it is a > poorly chosen name. The symbol is NOT defined as a command or even > as a function (it is fboundp but not functionp or commandp). > This name is misleading and confusing. > > The Elisp manual speaks better of `define-prefix-command', by saying > that it "prepares SYMBOL for use as a prefix key's binding" - nothing > about "prefix command". Such wording should be used also for the doc > string. True. I've now added a sentence mimicing the info text. > It would even be good to rename the function (keeping > `define-prefix-command' as a deprecated alias). Maybe something like > `prepare-symbol-for-prefix-key'. > > The doc should also make clear that the value it puts in the function > cell is a new, empty keymap. Thus, if you do > (define-prefix-command 'foo), and then you define keys in that keymap, > and then you do (define-prefix-command 'foo) again, the keys you > bound earlier are lost (since a new map is now used for foo). It says: A new sparse keymap is stored as COMMAND's function definition and its value. I think that's pretty unambiguous. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no