From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Noam Postavsky Newsgroups: gmane.emacs.bugs Subject: bug#26301: 24.5; `define-derived-mode': different signatures for doc string & manual Date: Fri, 26 Jul 2019 10:54:31 -0400 Message-ID: <855znokfrs.fsf@gmail.com> References: <8cad00f7-f86e-4d12-ad36-05214708aff1@default> <8736itnjkk.fsf@mouse.gnus.org> Mime-Version: 1.0 Content-Type: text/plain; charset=gb2312 Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="167446"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.1.92 (windows-nt) Cc: 26301@debbugs.gnu.org To: Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jul 26 16:55:08 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hr1cg-000hMr-DF for geb-bug-gnu-emacs@m.gmane.org; Fri, 26 Jul 2019 16:55:06 +0200 Original-Received: from localhost ([::1]:40826 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hr1cf-0007g5-FF for geb-bug-gnu-emacs@m.gmane.org; Fri, 26 Jul 2019 10:55:05 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:38104) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hr1cd-0007fz-De for bug-gnu-emacs@gnu.org; Fri, 26 Jul 2019 10:55:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hr1cc-0004h5-8q for bug-gnu-emacs@gnu.org; Fri, 26 Jul 2019 10:55:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:34332) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hr1cc-0004gl-5J for bug-gnu-emacs@gnu.org; Fri, 26 Jul 2019 10:55:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hr1cc-00012l-2O for bug-gnu-emacs@gnu.org; Fri, 26 Jul 2019 10:55:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Noam Postavsky Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 26 Jul 2019 14:55:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 26301 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: fixed Original-Received: via spool by 26301-submit@debbugs.gnu.org id=B26301.15641528803979 (code B ref 26301); Fri, 26 Jul 2019 14:55:02 +0000 Original-Received: (at 26301) by debbugs.gnu.org; 26 Jul 2019 14:54:40 +0000 Original-Received: from localhost ([127.0.0.1]:43153 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hr1cG-000127-7P for submit@debbugs.gnu.org; Fri, 26 Jul 2019 10:54:40 -0400 Original-Received: from mail-io1-f53.google.com ([209.85.166.53]:35072) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hr1cE-00011u-Ax for 26301@debbugs.gnu.org; Fri, 26 Jul 2019 10:54:38 -0400 Original-Received: by mail-io1-f53.google.com with SMTP id m24so105400877ioo.2 for <26301@debbugs.gnu.org>; Fri, 26 Jul 2019 07:54:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version:content-transfer-encoding; bh=ZCOqMhDJdFNJRi4PriQKQqYyet4gAr+JctxzeoSjnJA=; b=nVP4ZE5iA3CbPGaaXLiY0PDsKnAE62qz9iH9xRyVTvyjwhpFW0B7EiNWwKvI887i5E XoqAbGn/1bET7J+tQn5jY2ZCJlOjWczLTM/s3LEIPP/1klTojGOWXqo7wP5Trxfm5OlC MV1ZT6cSsqmAjFtmt0W/0N1213dJfpYmx0bOZSPYNXXiT0XFYrWJSVyPLrRjsM4MC7C5 gV9E0STS3wkv79RjZF4RXu3foQvI/0QEG56ch8yJSBEa+TDKQygRyrCD5/s2x8xyP7Um SEbTo3PBhyq9iSpNLXLuplcpIPbxb6a7pLgXCT9T1W6mJdYVA733Brs74IJ/mgOqVt/q VXDg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version:content-transfer-encoding; bh=ZCOqMhDJdFNJRi4PriQKQqYyet4gAr+JctxzeoSjnJA=; b=Kla0/z2N1//zaLkb+NqkrVQUQDLrPX2rPyKIWdM4sw/VdE4TbPaDkw5Ddr679CquS0 vm1ANIeJUURyVPvMToaFGBWwgw89BFf7eOwoHiQ2eC0QRR+cBW2dqV/OkK8Ae+nmUvXB MGQLPefG6mywn8AguVSShxBq4DyRW4wEjh1Drp4SFNUeieyRz0/eWePeKsBI5y9HssKe /BGzKZqRQt+o2IEfN4V2lmX37lc1sSXnXPMxWnV01DzwR0V8gpyStZZYTIC/4G9HjF7j zKx+Kz0wLgmjIrsYK5j37u0e9CeA/Mtt9SahnNXfRoLYaB15BvlOfuukcRVjWLpUSTb/ DqFQ== X-Gm-Message-State: APjAAAWf9uwgKsamTfOREfVXzxu4BGI3boU0fsRuU/K933NSKKa1h+uI pvZicD1xCY/gTGeoNBvjY27S1Ads X-Google-Smtp-Source: APXvYqyAsAY95sBeV9gGBgw5Vl0wp0lFAcOSzsEObfDoZPQcyqcdOGAhNz6I0lAIpuXMoeMhkXYt8A== X-Received: by 2002:a5d:96d8:: with SMTP id r24mr26069265iol.269.1564152872448; Fri, 26 Jul 2019 07:54:32 -0700 (PDT) Original-Received: from vhost2 (CPE001143542e1f-CMf81d0f809fa0.cpe.net.cable.rogers.com. [99.230.51.196]) by smtp.gmail.com with ESMTPSA id y17sm40769255ioa.40.2019.07.26.07.54.31 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 26 Jul 2019 07:54:31 -0700 (PDT) In-Reply-To: <8736itnjkk.fsf@mouse.gnus.org> (Lars Ingebrigtsen's message of "Fri, 26 Jul 2019 13:04:11 +0200") 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: 209.51.188.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:163794 Archived-At: Lars Ingebrigtsen writes: > Drew Adams writes: > >> The signature is ultimately the same but it is documented differently. >> It would be better to use the same signature spec for both, unless >> there is a good reason not to. >> >> In the manual it is declared as being: >> >> define-derived-mode variant parent name docstring keyword-args=A1=AD bo= dy=A1=AD >> >> In the doc string it is declared as being: >> >> (define-derived-mode CHILD PARENT NAME &optional DOCSTRING &rest BODY) >> >> No KEYWORD-ARGS. They are included in BODY, so the specifications of >> BODY differ between the two. > > I guess the manual here try to describe the conceptual semantics (i.e., > that if you put keywords there, they'll be interpreted as such), while > the doc string doesn't lie about what goes where. Because the calling > convention is automatically generated there, which makes pretending a > bit more difficult. Docstrings can override the automatically generated signature by using (fn ...) So maybe we should do that here?