From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#26301: 24.5; `define-derived-mode': different signatures for doc string & manual Date: Sat, 27 Jul 2019 17:01:30 -0700 (PDT) Message-ID: <04854612-43af-4085-8f2f-ff481ce329cb@default> References: <8cad00f7-f86e-4d12-ad36-05214708aff1@default> <8736itnjkk.fsf@mouse.gnus.org> <855znokfrs.fsf@gmail.com> <7e2203c3-0855-4716-9700-d2b31b4cc4ba@default> <87zhkzdssw.fsf@web.de> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="67839"; mail-complaints-to="usenet@blaine.gmane.org" Cc: Lars Ingebrigtsen , Noam Postavsky , 26301@debbugs.gnu.org To: Michael Heerdegen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Jul 28 02:02: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 1hrWdb-000HWb-Uc for geb-bug-gnu-emacs@m.gmane.org; Sun, 28 Jul 2019 02:02:08 +0200 Original-Received: from localhost ([::1]:47650 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hrWda-0006GJ-Iv for geb-bug-gnu-emacs@m.gmane.org; Sat, 27 Jul 2019 20:02:06 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:55691) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hrWdX-0006G5-Oh for bug-gnu-emacs@gnu.org; Sat, 27 Jul 2019 20:02:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hrWdW-00050o-Nk for bug-gnu-emacs@gnu.org; Sat, 27 Jul 2019 20:02:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:36765) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hrWdW-0004yk-GG for bug-gnu-emacs@gnu.org; Sat, 27 Jul 2019 20:02:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hrWdW-0005MA-Ch for bug-gnu-emacs@gnu.org; Sat, 27 Jul 2019 20:02: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: Sun, 28 Jul 2019 00:02: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.156427210720565 (code B ref 26301); Sun, 28 Jul 2019 00:02:02 +0000 Original-Received: (at 26301) by debbugs.gnu.org; 28 Jul 2019 00:01:47 +0000 Original-Received: from localhost ([127.0.0.1]:45586 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hrWdH-0005Ld-Fh for submit@debbugs.gnu.org; Sat, 27 Jul 2019 20:01:47 -0400 Original-Received: from aserp2120.oracle.com ([141.146.126.78]:36658) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hrWdG-0005LP-9Z for 26301@debbugs.gnu.org; Sat, 27 Jul 2019 20:01:46 -0400 Original-Received: from pps.filterd (aserp2120.oracle.com [127.0.0.1]) by aserp2120.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x6S00vxY155724; Sun, 28 Jul 2019 00:01:39 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : cc : subject : references : in-reply-to : content-type : content-transfer-encoding; s=corp-2018-07-02; bh=NSqb2T3pW/d+xrdzZ3mMzjwfJtK/v28X2bofh1jJDFM=; b=Ul0rdyyKgv+K87HBRMyziw4bZZ4bKLP5GRFKvs5FKdb3YqL4dH+j2AeyFaC0VpEGqONb BtvbTwfE1cP8Ot0M2vWto8pgOWGjvKmUS+U8OTG0PIKBA9tkaWCUZKqx7d9Pw0QtFOPy i68zsKIjYZCRrqOspgBQ42ReoDRfIPOWW0TnSwf09DuHqGFb1RYr5UqDW8mlVD0b+pgA mUbKWa1/CD++wKVP132L1RsOtu8Nsmjt84EAns3MoPZGvrPDgRBco979WVUTOph6GaSg L6VOUpLXHIdzs8bEFKW80abMcsM6JQYQ0uOx5pX7dzRb5RGoURaW5s3IZnhj716fVHOk dw== Original-Received: from aserp3020.oracle.com (aserp3020.oracle.com [141.146.126.70]) by aserp2120.oracle.com with ESMTP id 2u0ejp24u5-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sun, 28 Jul 2019 00:01:39 +0000 Original-Received: from pps.filterd (aserp3020.oracle.com [127.0.0.1]) by aserp3020.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x6RNrPww028861; Sun, 28 Jul 2019 00:01:39 GMT Original-Received: from aserv0122.oracle.com (aserv0122.oracle.com [141.146.126.236]) by aserp3020.oracle.com with ESMTP id 2u0ee34jye-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sun, 28 Jul 2019 00:01:38 +0000 Original-Received: from abhmp0004.oracle.com (abhmp0004.oracle.com [141.146.116.10]) by aserv0122.oracle.com (8.14.4/8.14.4) with ESMTP id x6S01VVO003290; Sun, 28 Jul 2019 00:01:38 GMT In-Reply-To: <87zhkzdssw.fsf@web.de> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4873.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9331 signatures=668685 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=866 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1906280000 definitions=main-1907270302 X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9331 signatures=668685 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=916 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1906280000 definitions=main-1907270303 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:163923 Archived-At: > > However, in that case, KEYWORDS is the _wrong_ name. >=20 > In a similar case, `define-globalized-minor-mode' uses the name KEYS > (it's the name of the &rest arg though). If each of the args in the &rest list is a KEY then that's fine. > > The name should be KEYWORD or KEYWORD-ENTRY or KEYWORD-PAIR or some > > such. >=20 > I all find that not better. KEYWORD fails to say that values are > included. KEYWORD-ENTRY and KEYWORD-PAIR are confising, they make it > look like you would have to specify conses or two element lists. >=20 > I would prefer something like [KEYWORD VALUE ...], though I guess that > would then confuse eldoc. That's incorrect, I think, because it indicates that VALUE is what is possibly repeated. If the convention doesn't actually specify that (I'm not sure) that's at least what someone might suppose. Dunno whether our convention allows [KEYWORD VALUE]... (i.e., with the ... after the optional indication). Otherwise, I'd suggest a name such as KEYWORD+VALUE: [KEYWORD+VALUE...] (If this were not something added automatically by handling (fn ...) then a single name (e.g. FOOBAR) could be broken down in the doc string, saying that FOOBAR is a keyword followed by its value.)