From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#37063: 26.2.90; Problems with recent CL support in checkdoc Date: Thu, 10 Oct 2019 02:22:52 +0200 Message-ID: <87mue9sb37.fsf@gnus.org> References: <87imqw10je.fsf@cassou.me> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="211569"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: Alex Branham , 37063@debbugs.gnu.org To: Damien Cassou Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Oct 10 02:23:24 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 1iIMEl-000srZ-BY for geb-bug-gnu-emacs@m.gmane.org; Thu, 10 Oct 2019 02:23:23 +0200 Original-Received: from localhost ([::1]:60985 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iIMEk-0005g9-8U for geb-bug-gnu-emacs@m.gmane.org; Wed, 09 Oct 2019 20:23:22 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:45109) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iIMES-0005SM-97 for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 20:23:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iIMER-0005l6-7i for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 20:23:04 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:45708) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iIMER-0005kz-4l for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 20:23:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iIMER-0002u2-0p for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 20:23:03 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 10 Oct 2019 00:23:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 37063 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 37063-submit@debbugs.gnu.org id=B37063.157066697711114 (code B ref 37063); Thu, 10 Oct 2019 00:23:02 +0000 Original-Received: (at 37063) by debbugs.gnu.org; 10 Oct 2019 00:22:57 +0000 Original-Received: from localhost ([127.0.0.1]:54525 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIMEL-0002tC-KC for submit@debbugs.gnu.org; Wed, 09 Oct 2019 20:22:57 -0400 Original-Received: from quimby.gnus.org ([80.91.231.51]:47984) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIMEK-0002t4-0Z for 37063@debbugs.gnu.org; Wed, 09 Oct 2019 20:22:56 -0400 Original-Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=marnie) by quimby.gnus.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iIMEG-0006ZL-GJ; Thu, 10 Oct 2019 02:22:54 +0200 In-Reply-To: <87imqw10je.fsf@cassou.me> (Damien Cassou's message of "Sat, 17 Aug 2019 13:41:57 +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:168828 Archived-At: Damien Cassou writes: > In the context of bug#37034, some initial support for CL functions and > methods was added to checkdoc. On my code, the changes make checkdoc > trigger warnings on perfectly valid code IMO. For example, > > (cl-defmethod foo ((a list)) "Return A.") > > Checkdoc complains that LIST should be described. I disagree with that, > list is a type, not a argument name. > > I attach to this bug report a patch introducing test cases to > checkdoc-tests.el. If it's not possible to implement full support for CL > I prefer that checkdoc doesn't complain even if there is a bug in the > docstring rather than checkdoc complains when the docstring is correct. After a patch was submitted that fixed most of the cases (except the &context and &aux ones, I believe), I've applied your checkdoc-tests.el patch (except those two functions). -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no