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#17567: 24.4.50; doc string of `define-derived-mode' Date: Fri, 23 May 2014 12:35:53 -0700 (PDT) Message-ID: <8e27e542-96e8-4342-a761-8c066fe3d307@default> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1400873853 26304 80.91.229.3 (23 May 2014 19:37:33 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 23 May 2014 19:37:33 +0000 (UTC) To: 17567@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri May 23 21:37:25 2014 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 1WnvHQ-00019c-6X for geb-bug-gnu-emacs@m.gmane.org; Fri, 23 May 2014 21:37:24 +0200 Original-Received: from localhost ([::1]:45360 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WnvHP-0003mR-Qb for geb-bug-gnu-emacs@m.gmane.org; Fri, 23 May 2014 15:37:23 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:32773) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WnvHD-0003lx-M0 for bug-gnu-emacs@gnu.org; Fri, 23 May 2014 15:37:20 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WnvH4-0005Ja-Uw for bug-gnu-emacs@gnu.org; Fri, 23 May 2014 15:37:11 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:59332) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WnvH4-0005JR-RH for bug-gnu-emacs@gnu.org; Fri, 23 May 2014 15:37:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1WnvH4-0001ye-88 for bug-gnu-emacs@gnu.org; Fri, 23 May 2014 15:37:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 23 May 2014 19:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 17567 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 17567-submit@debbugs.gnu.org id=B17567.14008737697512 (code B ref 17567); Fri, 23 May 2014 19:37:02 +0000 Original-Received: (at 17567) by debbugs.gnu.org; 23 May 2014 19:36:09 +0000 Original-Received: from localhost ([127.0.0.1]:58209 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WnvGD-0001x6-6w for submit@debbugs.gnu.org; Fri, 23 May 2014 15:36:09 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:25896) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WnvG9-0001wU-Ng for 17567@debbugs.gnu.org; Fri, 23 May 2014 15:36:06 -0400 Original-Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id s4NJZwdB032090 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for <17567@debbugs.gnu.org>; Fri, 23 May 2014 19:35:59 GMT Original-Received: from userz7022.oracle.com (userz7022.oracle.com [156.151.31.86]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s4NJZvCm000632 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for <17567@debbugs.gnu.org>; Fri, 23 May 2014 19:35:58 GMT Original-Received: from abhmp0003.oracle.com (abhmp0003.oracle.com [141.146.116.9]) by userz7022.oracle.com (8.14.5+Sun/8.14.4) with ESMTP id s4NJZsrb028577 for <17567@debbugs.gnu.org>; Fri, 23 May 2014 19:35:56 GMT In-Reply-To: X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6691.5000 (x86)] X-Source-IP: acsinet22.oracle.com [141.146.126.238] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.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:89417 Archived-At: Also, the doc string should state the types of the values of keywords :group, :syntax-table, and :abbrev-table. And it says that the mode runs the hook constructed by function `derived-mode-hook-name'. Constructed how? What does constructed mean here? And the doc string of `derived-mode-hook-name' is no help here: "Construct a mode-hook name based on a MODE name." The arg is MODE. What is it? What data type? And what is its "name"? What does it mean to construct a hook name? And how is that name constructed from the "MODE name"? And what about the contradiction between the doc string of `define-derived-mode' and that of `derived-mode-hook-name'? The former says that `d-m-h-name' constructs a _hook_. The latter says that it constructs a hook _name_. Far clearer for `derived-mode-hook-name' would be to just say what it really does: Return a symbol whose name is "-hook" appended to the `symbol-name' of MODE. That also makes it clear that MODE is expected to be a symbol. (Similarly, for the other `defsubst's in derived.el.)