From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#17567: 24.4.50; doc string of `define-derived-mode' Date: Sat, 25 Sep 2021 10:15:16 -0700 Message-ID: References: <8e27e542-96e8-4342-a761-8c066fe3d307@default> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="12597"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: 17567@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Sep 25 19:16:15 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mUBHb-000332-30 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 25 Sep 2021 19:16:15 +0200 Original-Received: from localhost ([::1]:53054 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mUBHZ-0000mN-Tc for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 25 Sep 2021 13:16:13 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:33752) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mUBHO-0000l4-53 for bug-gnu-emacs@gnu.org; Sat, 25 Sep 2021 13:16:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:51252) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mUBHN-0000UI-Tq for bug-gnu-emacs@gnu.org; Sat, 25 Sep 2021 13:16:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mUBHN-0004ge-MA for bug-gnu-emacs@gnu.org; Sat, 25 Sep 2021 13:16:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 25 Sep 2021 17:16:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 17567 X-GNU-PR-Package: emacs Original-Received: via spool by 17567-submit@debbugs.gnu.org id=B17567.163259012517958 (code B ref 17567); Sat, 25 Sep 2021 17:16:01 +0000 Original-Received: (at 17567) by debbugs.gnu.org; 25 Sep 2021 17:15:25 +0000 Original-Received: from localhost ([127.0.0.1]:34559 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mUBGn-0004fV-0l for submit@debbugs.gnu.org; Sat, 25 Sep 2021 13:15:25 -0400 Original-Received: from mail-pl1-f178.google.com ([209.85.214.178]:34594) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mUBGl-0004f9-08 for 17567@debbugs.gnu.org; Sat, 25 Sep 2021 13:15:23 -0400 Original-Received: by mail-pl1-f178.google.com with SMTP id a7so8743845plm.1 for <17567@debbugs.gnu.org>; Sat, 25 Sep 2021 10:15:22 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:in-reply-to:references:user-agent :mime-version:date:message-id:subject:to:cc; bh=6C5qdby65KdUvXvWOdLlpKDaXlDtcjdOUfrMdspTCko=; b=68yneDDpL/NB6YNgTkiT5uILhLaUhsr1utwy6NKxKJvAKr/LQEEOO9Zc3YG35eng4u LTCD2rFPZY6CcIyQysVm8i+dTfw8urebRer3QHY2JRKOKnZaDf0fdc26X1Ok4JYEPMmy pvPqWe8zXpIejXNRwTMLkY7/bzEuJAAN666PyWM7x7L+sH95Hk7wbOPW1t0ySxWacKnJ jjOxqNXlN0kFNtES+TQJM0kT3ZTN+y5sA7NqnC+5Hr6sqcn/Smz5EXJUWrOg9aYScdwn ogG1CgtBoJqRMfyXL0oeSUJA7KO/4gP7eqoWBvUN9NslK6lf5iOPcCFL769Y1E2OJWPa igLw== X-Gm-Message-State: AOAM532qUK4MxpGRuYAcuYuj86tnGLG2eKcNS9tf0s/MHLiQ7kzK/Bpr RCYvUZKsEbPKGGl00/PiAqamFLOEsG4kz8t46ew= X-Google-Smtp-Source: ABdhPJyipXHY8qLnndxSaNWRy5osCCcVUXd/tJxZZmi6Csxdzlvn9ehr4DTZ6jBmz/U42SB8wl8sGkfhCPR33P0KATo= X-Received: by 2002:a17:90a:460a:: with SMTP id w10mr9235849pjg.132.1632590117283; Sat, 25 Sep 2021 10:15:17 -0700 (PDT) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 25 Sep 2021 10:15:16 -0700 In-Reply-To: <8e27e542-96e8-4342-a761-8c066fe3d307@default> (Drew Adams's message of "Fri, 23 May 2014 12:35:53 -0700 (PDT)") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:215478 Archived-At: tags 17567 + fixed close 17567 28.1 thanks Drew Adams writes: > The doc string erroneously says that parameter NAME is "a string > which will appear in the status line". > > Emacs does not have a "status line". That term is used nowhere. > > What should be said about NAME is that it defines the value of variable > `mode-name' for mode CHILD. A user consulting that variable will see > that its value is used in the mode line etc. Drew Adams writes: > 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.) I have now fixed this on (commit e4c9081d46). This change will be a part of the upcoming Emacs 28.1. Please verify that this fix works for you, but for now I'm closing this bug report. If you see anything that is wrong, please reply to this email (use "Reply to all" in your email client) and we can reopen the bug report. You could also just report a new bug. Thanks again for the bug report!