From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#55905: warn about misplaced or duplicated doc strings, `declare` or `interactive` forms Date: Sat, 11 Jun 2022 14:44:59 +0200 Message-ID: <87leu3qshg.fsf@gnus.org> References: <7541DAE8-38BD-4CF6-A652-744E31C42442@acm.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="19793"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: 55905@debbugs.gnu.org To: Mattias =?UTF-8?Q?Engdeg=C3=A5rd?= Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Jun 11 14:46:29 2022 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 1o00VY-0004wJ-U1 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 11 Jun 2022 14:46:28 +0200 Original-Received: from localhost ([::1]:56090 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1o00VX-0007de-Cr for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 11 Jun 2022 08:46:27 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:60604) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1o00V8-0007dO-5B for bug-gnu-emacs@gnu.org; Sat, 11 Jun 2022 08:46:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:58184) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1o00V7-0000kz-RT for bug-gnu-emacs@gnu.org; Sat, 11 Jun 2022 08:46:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1o00V7-0007yI-Pz for bug-gnu-emacs@gnu.org; Sat, 11 Jun 2022 08:46:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 11 Jun 2022 12:46:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 55905 X-GNU-PR-Package: emacs Original-Received: via spool by 55905-submit@debbugs.gnu.org id=B55905.165495151027283 (code B ref 55905); Sat, 11 Jun 2022 12:46:01 +0000 Original-Received: (at 55905) by debbugs.gnu.org; 11 Jun 2022 12:45:10 +0000 Original-Received: from localhost ([127.0.0.1]:52081 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1o00UI-00075i-BC for submit@debbugs.gnu.org; Sat, 11 Jun 2022 08:45:10 -0400 Original-Received: from quimby.gnus.org ([95.216.78.240]:44544) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1o00UG-0006y4-Ji for 55905@debbugs.gnu.org; Sat, 11 Jun 2022 08:45:09 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Transfer-Encoding:Content-Type:MIME-Version:Message-ID :In-Reply-To:Date:References:Subject:Cc:To:From:Sender:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=8Dmwga5YxessS8gevO+PTJq68oK0aeDiFh1wnUuqiuk=; b=IsHBFWDx+0dz6SF7IIJrYDQ9KF kGq+JUmOEA2euV6LuWdkjHK37Ylzz3GscpwpcK5rnNIfBW2/0QuwiUOsVAhJ66vHFEUjG8U5lsHY6 5+QQqfb7YVOz2J6mJJyohcTH0Q3oRTZqSt00tPpCt1/vwiPF/RrjNs1iORRe9FCuQVlw=; Original-Received: from [84.212.220.105] (helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1o00U7-0000w7-Rs; Sat, 11 Jun 2022 14:45:02 +0200 X-Now-Playing: Various's _We Are Not Alone Pt. 1_: "RE-15" In-Reply-To: <7541DAE8-38BD-4CF6-A652-744E31C42442@acm.org> ("Mattias =?UTF-8?Q?Engdeg=C3=A5rd?="'s message of "Sat, 11 Jun 2022 14:07:03 +0200") 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:234277 Archived-At: Mattias Engdeg=C3=A5rd writes: > In function definitions, doc strings, `declare` and `interactive` > forms are each optional but must appear in that order and duplications > are not permitted. Many violations against these rules go undetected. > > The attached patch adds checks to `defun` and `defmacro`. Violations > result in compilation warnings but it could be changed into hard > errors if desired. It also accepts `(:documentation EXPR)` as > alternative to a doc string literal, which currently doesn't work i > all cases. This is most welcome -- I can never remember myself what the order of declare and interactive is. --=20 (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no