From unknown Wed Jun 18 23:12:45 2025 X-Loop: help-debbugs@gnu.org Subject: bug#37063: 26.2.90; Problems with recent CL support in checkdoc Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 17 Aug 2019 11:43:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 37063 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 37063@debbugs.gnu.org Cc: Alex Branham , Lars Ingebrigtsen X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.156604213628563 (code B ref -1); Sat, 17 Aug 2019 11:43:01 +0000 Received: (at submit) by debbugs.gnu.org; 17 Aug 2019 11:42:16 +0000 Received: from localhost ([127.0.0.1]:55380 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hyx68-0007Qc-GN for submit@debbugs.gnu.org; Sat, 17 Aug 2019 07:42:16 -0400 Received: from lists.gnu.org ([209.51.188.17]:55496) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hyx66-0007QT-21 for submit@debbugs.gnu.org; Sat, 17 Aug 2019 07:42:14 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:38470) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1hyx64-0003hK-K1 for bug-gnu-emacs@gnu.org; Sat, 17 Aug 2019 07:42:13 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=0.8 required=5.0 tests=BAYES_50,URIBL_BLOCKED autolearn=disabled version=3.3.2 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hyx63-0002oh-70 for bug-gnu-emacs@gnu.org; Sat, 17 Aug 2019 07:42:12 -0400 Received: from mail.choca.pics ([2001:bc8:20ab::1]:36108) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hyx62-0002lC-UE for bug-gnu-emacs@gnu.org; Sat, 17 Aug 2019 07:42:11 -0400 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 2DD5BF1BC17; Sat, 17 Aug 2019 13:42:00 +0200 (CEST) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id sYU5_XHlvHHQ; Sat, 17 Aug 2019 13:41:59 +0200 (CEST) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 2B0D0F1BC19; Sat, 17 Aug 2019 13:41:59 +0200 (CEST) X-Virus-Scanned: amavisd-new at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id mrf1lu4Ylubv; Sat, 17 Aug 2019 13:41:59 +0200 (CEST) Received: from luz4 (199.138.120.78.rev.sfr.net [78.120.138.199]) by mail.choca.pics (Postfix) with ESMTPSA id D1E1DF1BC17; Sat, 17 Aug 2019 13:41:58 +0200 (CEST) From: Damien Cassou Date: Sat, 17 Aug 2019 13:41:57 +0200 Message-ID: <87imqw10je.fsf@cassou.me> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:bc8:20ab::1 X-Spam-Score: -1.4 (-) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.4 (--) --=-=-= Content-Type: text/plain 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. Best, -- Damien Cassou http://damiencassou.seasidehosting.st "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-checkdoc-CL-tests.patch >From d7357884819f8921ff1a27dd3a25bdfd882d1c5a Mon Sep 17 00:00:00 2001 From: Damien Cassou Date: Fri, 16 Aug 2019 20:42:26 +0200 Subject: [PATCH] checkdoc CL tests --- test/lisp/emacs-lisp/checkdoc-tests.el | 61 ++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/test/lisp/emacs-lisp/checkdoc-tests.el b/test/lisp/emacs-lisp/checkdoc-tests.el index 1cefc4c366..ee4c1fb5a6 100644 --- a/test/lisp/emacs-lisp/checkdoc-tests.el +++ b/test/lisp/emacs-lisp/checkdoc-tests.el @@ -37,6 +37,67 @@ (insert "(defun foo())") (should-error (checkdoc-defun) :type 'user-error))) +(ert-deftest checkdoc-cl-defmethod-ok () + "Checkdoc should be happy with a simple correct cl-defmethod." + (with-temp-buffer + (emacs-lisp-mode) + (insert "(cl-defmethod foo (a) \"Return A.\")") + (checkdoc-defun))) + +(ert-deftest checkdoc-cl-defmethod-with-types-ok () + "Checkdoc should be happy with a cl-defmethod using types." + (with-temp-buffer + (emacs-lisp-mode) + ;; this method matches if A is the symbol `smthg' and if b is a list: + (insert "(cl-defmethod foo ((a (eql smthg)) (b list)) \"Return A+B.\")") + (checkdoc-defun))) + +(ert-deftest checkdoc-cl-defun-with-key-ok () + "Checkdoc should be happy with a cl-defun using &key." + (with-temp-buffer + (emacs-lisp-mode) + (insert "(cl-defun foo (&key a (b 27)) \"Return :A+:B.\")") + (checkdoc-defun))) + +(ert-deftest checkdoc-cl-defun-with-allow-other-keys-ok () + "Checkdoc should be happy with a cl-defun using &allow-other-keys." + (with-temp-buffer + (emacs-lisp-mode) + (insert "(cl-defun foo (&key a &allow-other-keys) \"Return :A.\")") + (checkdoc-defun))) + +(ert-deftest checkdoc-cl-defun-with-aux-ok () + "Checkdoc should be happy with a cl-defun using &aux." + (with-temp-buffer + (emacs-lisp-mode) + (insert "(cl-defun foo (a b &aux (c (+ a b))) \"Return A and B.\")") + (checkdoc-defun))) + +(ert-deftest checkdoc-cl-defun-with-default-optional-value-ok () + "Checkdoc should be happy with a cl-defun using default values for optional args." + (with-temp-buffer + (emacs-lisp-mode) + ;; B is optional and equals 1+a if not provided. HAS-BS is non-nil + ;; if B was provided in the call: + (insert "(cl-defun foo (a &optional (b (1+ a) has-bs)) \"Return A + B.\")") + (checkdoc-defun))) + +(ert-deftest checkdoc-cl-defun-with-destructuring-ok () + "Checkdoc should be happy with a cl-defun destructuring its arguments." + (with-temp-buffer + (emacs-lisp-mode) + (insert "(cl-defun foo ((a b &optional c) d) \"Return A+B+C+D.\")") + (checkdoc-defun))) + +(ert-deftest checkdoc-cl-defmethod-with-context-ok () + "Checkdoc should ignore context specializers in a cl-defmethod." + (with-temp-buffer + (emacs-lisp-mode) + ;; A context specializer is used to select the correct method but + ;; doesn't have to appear in the docstring: + (insert "(cl-defmethod foo (a &context (global-var (eql foo))) \"Return A.\")") + (checkdoc-defun))) + (ert-deftest checkdoc-tests--next-docstring () "Checks that the one-argument form of `defvar' works. See the comments in Bug#24998." -- 2.21.0 --=-=-=-- From unknown Wed Jun 18 23:12:45 2025 X-Loop: help-debbugs@gnu.org Subject: bug#37063: 26.2.90; Problems with recent CL support in checkdoc Resent-From: dick.r.chiang@gmail.com Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 30 Sep 2019 16:53:01 +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: To: 37063@debbugs.gnu.org Received: via spool by 37063-submit@debbugs.gnu.org id=B37063.156986236515951 (code B ref 37063); Mon, 30 Sep 2019 16:53:01 +0000 Received: (at 37063) by debbugs.gnu.org; 30 Sep 2019 16:52:45 +0000 Received: from localhost ([127.0.0.1]:60410 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iEyui-00049D-WD for submit@debbugs.gnu.org; Mon, 30 Sep 2019 12:52:45 -0400 Received: from mail-qt1-f172.google.com ([209.85.160.172]:36198) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iEyuh-00048z-MK for 37063@debbugs.gnu.org; Mon, 30 Sep 2019 12:52:44 -0400 Received: by mail-qt1-f172.google.com with SMTP id o12so17917379qtf.3 for <37063@debbugs.gnu.org>; Mon, 30 Sep 2019 09:52:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:references:date:in-reply-to:message-id:user-agent :mime-version:content-disposition:content-description; bh=UomRc+uNErI/hvGI5Brk+xgRnRMpCPjZXS5vo6ASXeY=; b=kW9ZUx63Ob0Q+gM167gZu1UmRDHszgv4sgEHOteCPQVUKF2xVJQDIk3PSfRaks/2MV PxYrkqGvTgL6tTGITXt6jNF6zr3oaRSKCwJ0RmI4v8rlromMJuSZNGV1GXjQzHH1MkZj KK+gquhDTA88Ld/XsbrDGHXAbIwhwEIRvcbezISE0iID81ANFQstZsweOFxXST0Iolzw KWht/iIcN4M2J87NXE/VCHMWhqlZlPcexRMo5/wmppYzpq/5DabR4iBbVnaG4JtUafq6 qBmQowwd3Qa+t37RPa2GM6K0SC0Qc9VCPuutOVdHXmMtQCb1TNPvA+XHGDdt/uSau1a6 dYBg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:references:date:in-reply-to :message-id:user-agent:mime-version:content-disposition :content-description; bh=UomRc+uNErI/hvGI5Brk+xgRnRMpCPjZXS5vo6ASXeY=; b=S1JMNjRDj6Bmc3BuGpgLDb6SbofsiSAeLvVrsBtmfF1PuYEYmidvGAvLp7KVcia6V4 qZ1uKuLBgNP3txE1keIJelqNb+62xDS74J+PEn1gjC209MWplwDtZCvSrosh6B8EGq6g yR7gMyFp7G55ElAq61yN4hKTjv1u1hTOJoE9c0bkliB41CkuTXkNQJ8nOIxVIFQ/aTMR V27CFVjjtngCyC03KOr6uP5vP/TbuR+BWARAhKorDjuGtZEPggg6mVombwsZL8gLbM3+ ViU3ucSW6f/fwwKncAq1DoBK3q+OVcWvL+Lwf69FG9y3DNBk/iXLXYA9wJK9QipFd6w+ i/hw== X-Gm-Message-State: APjAAAV3atizW3hJidLCfQT6g2NxLi6A9cPNfjjNJDO4aBo2H96a3ZuI DgjAGIIb5IoD8NO6idkx6QVQjAZi X-Google-Smtp-Source: APXvYqw/CuWgOs43h+G15xA8kg1GPWEnPtfuCAesesiRLzc6hjoJ486UM7exQiArB1wAeVjSzSThmA== X-Received: by 2002:ad4:4251:: with SMTP id l17mr21514165qvq.148.1569862357831; Mon, 30 Sep 2019 09:52:37 -0700 (PDT) Received: from localhost (pool-100-33-98-8.nycmny.fios.verizon.net. [100.33.98.8]) by smtp.gmail.com with ESMTPSA id z200sm6486060qkb.5.2019.09.30.09.52.37 for <37063@debbugs.gnu.org> (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 30 Sep 2019 09:52:37 -0700 (PDT) From: dick.r.chiang@gmail.com X-Google-Original-From: 37063@debbugs.gnu.org References: <87imqw10je.fsf@cassou.me> Date: Mon, 30 Sep 2019 12:52:36 -0400 In-Reply-To: <87imqw10je.fsf@cassou.me> (Damien Cassou's message of "Sat, 17 Aug 2019 13:41:57 +0200") Message-ID: <87sgodiv57.fsf@dick> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/x-diff Content-Disposition: inline; filename=0001-checkdoc-identifying-formal-args.patch Content-Description: checkdoc fix X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) >From c97b08a1d6df46f674a18ab83ae86dc6a5ad3aa0 Mon Sep 17 00:00:00 2001 From: dickmao Date: Mon, 30 Sep 2019 10:04:49 -0400 Subject: [PATCH] ; checkdoc identifying formal args * lisp/emacs-lisp/checkdoc.el (checkdoc-defun-info): * test/lisp/emacs-lisp/checkdoc-tests.el: (Bug#37063) --- lisp/emacs-lisp/checkdoc.el | 5 ++--- test/lisp/emacs-lisp/checkdoc-tests.el | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el index 51fb75da69..6c40bdf632 100644 --- a/lisp/emacs-lisp/checkdoc.el +++ b/lisp/emacs-lisp/checkdoc.el @@ -1952,11 +1952,10 @@ checkdoc-defun-info ;; new obarray. (if (not (listp lst)) (setq lst nil)) (unless is-advice - ;; lst here can be something like ((foo bar) baz) from + ;; (car lst) can be something like ((foo bar) baz) from ;; cl-lib methods; flatten it: - (setq lst (flatten-tree lst)) (while lst - (setq ret (cons (symbol-name (car lst)) ret) + (setq ret (cons (symbol-name (car (flatten-tree (car lst)))) ret) lst (cdr lst))))) (nreverse ret)))) diff --git a/test/lisp/emacs-lisp/checkdoc-tests.el b/test/lisp/emacs-lisp/checkdoc-tests.el index 1cefc4c366..b3cc943ac0 100644 --- a/test/lisp/emacs-lisp/checkdoc-tests.el +++ b/test/lisp/emacs-lisp/checkdoc-tests.el @@ -50,4 +50,20 @@ checkdoc-tests--next-docstring (should (looking-at-p "\"baz\")")) (should-not (checkdoc-next-docstring)))) +(ert-deftest checkdoc-tests--cl-defun () + "Identify formal arguments from arbitary lisp code." + (with-temp-buffer + (let ((checkdoc-autofix-flag 'never)) + (emacs-lisp-mode) + (insert "(cl-defun foo(&key bar &aux (baz (baz bar))) \"BAR BAZ.\")") + (should-not (checkdoc-defun))))) + +(ert-deftest checkdoc-tests--cl-defmethod () + "Identify formal arguments from object types." + (with-temp-buffer + (let ((checkdoc-autofix-flag 'never)) + (emacs-lisp-mode) + (insert "(cl-defmethod foo((a list)) \"Return A.\")") + (should-not (checkdoc-defun))))) + ;;; checkdoc-tests.el ends here -- 2.23.0 From debbugs-submit-bounces@debbugs.gnu.org Wed Oct 09 20:04:34 2019 Received: (at control) by debbugs.gnu.org; 10 Oct 2019 00:04:34 +0000 Received: from localhost ([127.0.0.1]:54502 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iILwW-0000Lo-Em for submit@debbugs.gnu.org; Wed, 09 Oct 2019 20:04:34 -0400 Received: from quimby.gnus.org ([80.91.231.51]:47666) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iILwU-0000Lc-DI for control@debbugs.gnu.org; Wed, 09 Oct 2019 20:04:30 -0400 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 1iILwR-0006NI-JR for control@debbugs.gnu.org; Thu, 10 Oct 2019 02:04:29 +0200 Date: Thu, 10 Oct 2019 02:04:27 +0200 Message-Id: <87v9sxsbxw.fsf@gnus.org> To: control@debbugs.gnu.org From: Lars Ingebrigtsen Subject: control message for bug #37063 X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see @@CONTACT_ADDRESS@@ for details. Content preview: tags 37063 + patch quit Content analysis details: (-2.9 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) tags 37063 + patch quit From unknown Wed Jun 18 23:12:45 2025 X-Loop: help-debbugs@gnu.org Subject: bug#37063: 26.2.90; Problems with recent CL support in checkdoc 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 To: dick.r.chiang@gmail.com Cc: 37063@debbugs.gnu.org Received: via spool by 37063-submit@debbugs.gnu.org id=B37063.157066692211033 (code B ref 37063); Thu, 10 Oct 2019 00:23:02 +0000 Received: (at 37063) by debbugs.gnu.org; 10 Oct 2019 00:22:02 +0000 Received: from localhost ([127.0.0.1]:54522 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIMDS-0002ri-60 for submit@debbugs.gnu.org; Wed, 09 Oct 2019 20:22:02 -0400 Received: from quimby.gnus.org ([80.91.231.51]:47954) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIMDP-0002rV-E3 for 37063@debbugs.gnu.org; Wed, 09 Oct 2019 20:21:59 -0400 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 1iIMDL-0006Yr-IL; Thu, 10 Oct 2019 02:21:57 +0200 From: Lars Ingebrigtsen References: <87imqw10je.fsf@cassou.me> <87sgodiv57.fsf@dick> Date: Thu, 10 Oct 2019 02:21:55 +0200 In-Reply-To: <87sgodiv57.fsf@dick> (dick r. chiang's message of "Mon, 30 Sep 2019 12:52:36 -0400") Message-ID: <87r23lsb4s.fsf@gnus.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see @@CONTACT_ADDRESS@@ for details. Content preview: dick.r.chiang@gmail.com writes: > diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el > index 51fb75da69..6c40bdf632 100644 > --- a/lisp/emacs-lisp/checkdoc.el > +++ b/lisp/emacs-lisp/checkdoc.el > @@ -1952, 11 +19 [...] Content analysis details: (-2.9 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) dick.r.chiang@gmail.com writes: > diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el > index 51fb75da69..6c40bdf632 100644 > --- a/lisp/emacs-lisp/checkdoc.el > +++ b/lisp/emacs-lisp/checkdoc.el > @@ -1952,11 +1952,10 @@ checkdoc-defun-info > ;; new obarray. > (if (not (listp lst)) (setq lst nil)) > (unless is-advice > - ;; lst here can be something like ((foo bar) baz) from > + ;; (car lst) can be something like ((foo bar) baz) from > ;; cl-lib methods; flatten it: > - (setq lst (flatten-tree lst)) > (while lst > - (setq ret (cons (symbol-name (car lst)) ret) > + (setq ret (cons (symbol-name (car (flatten-tree (car lst)))) ret) > lst (cdr lst))))) > (nreverse ret)))) Thank you; I've now applied your patch here since it seems to fix the use cases reported. However, I didn't include the tests in your patch, since they seemed to cover the same cases as Damien's (and they were more extensive, so I applied those instead). Besides, it doesn't look like you have copyright assignment papers on file, and for larger patches we require copyright assignments to the FSF. If you plan on submitting further patches in the future, it might be a good idea to do the paperwork now -- would you be willing to do so? -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no From unknown Wed Jun 18 23:12:45 2025 X-Loop: help-debbugs@gnu.org Subject: bug#37063: 26.2.90; Problems with recent CL support in checkdoc 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 To: Damien Cassou Cc: Alex Branham , 37063@debbugs.gnu.org Received: via spool by 37063-submit@debbugs.gnu.org id=B37063.157066697711114 (code B ref 37063); Thu, 10 Oct 2019 00:23:02 +0000 Received: (at 37063) by debbugs.gnu.org; 10 Oct 2019 00:22:57 +0000 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 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 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 From: Lars Ingebrigtsen References: <87imqw10je.fsf@cassou.me> Date: Thu, 10 Oct 2019 02:22:52 +0200 In-Reply-To: <87imqw10je.fsf@cassou.me> (Damien Cassou's message of "Sat, 17 Aug 2019 13:41:57 +0200") Message-ID: <87mue9sb37.fsf@gnus.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see @@CONTACT_ADDRESS@@ for details. Content preview: 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 exam [...] Content analysis details: (-2.9 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) 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 From debbugs-submit-bounces@debbugs.gnu.org Wed Oct 09 20:23:02 2019 Received: (at control) by debbugs.gnu.org; 10 Oct 2019 00:23:02 +0000 Received: from localhost ([127.0.0.1]:54528 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIMEP-0002tT-Sn for submit@debbugs.gnu.org; Wed, 09 Oct 2019 20:23:02 -0400 Received: from quimby.gnus.org ([80.91.231.51]:48000) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIMEO-0002tL-3G for control@debbugs.gnu.org; Wed, 09 Oct 2019 20:23:00 -0400 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 1iIMEL-0006ZT-DT for control@debbugs.gnu.org; Thu, 10 Oct 2019 02:22:59 +0200 Date: Thu, 10 Oct 2019 02:22:57 +0200 Message-Id: <87lfttsb32.fsf@gnus.org> To: control@debbugs.gnu.org From: Lars Ingebrigtsen Subject: control message for bug #37063 X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see @@CONTACT_ADDRESS@@ for details. Content preview: tags 37063 fixed close 37063 27.1 quit Content analysis details: (-2.9 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) tags 37063 fixed close 37063 27.1 quit From unknown Wed Jun 18 23:12:45 2025 X-Loop: help-debbugs@gnu.org Subject: bug#37063: 26.2.90; Problems with recent CL support in checkdoc Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 10 Oct 2019 04:16: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: fixed patch To: Lars Ingebrigtsen Cc: Alex Branham , 37063@debbugs.gnu.org Received: via spool by 37063-submit@debbugs.gnu.org id=B37063.15706809108584 (code B ref 37063); Thu, 10 Oct 2019 04:16:02 +0000 Received: (at 37063) by debbugs.gnu.org; 10 Oct 2019 04:15:10 +0000 Received: from localhost ([127.0.0.1]:54920 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIPr4-0002EO-21 for submit@debbugs.gnu.org; Thu, 10 Oct 2019 00:15:10 -0400 Received: from mail.choca.pics ([62.210.108.126]:48104) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIPr2-0002ED-36 for 37063@debbugs.gnu.org; Thu, 10 Oct 2019 00:15:09 -0400 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 8AB22F1CF8C; Thu, 10 Oct 2019 06:15:06 +0200 (CEST) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id NjPGsxSMoBBe; Thu, 10 Oct 2019 06:15:06 +0200 (CEST) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 04994F1CF8E; Thu, 10 Oct 2019 06:15:06 +0200 (CEST) X-Virus-Scanned: amavisd-new at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id R6yvwLEU9utW; Thu, 10 Oct 2019 06:15:05 +0200 (CEST) Received: from luz4 (199.138.120.78.rev.sfr.net [78.120.138.199]) by mail.choca.pics (Postfix) with ESMTPSA id B4C4BF1CF8C; Thu, 10 Oct 2019 06:15:05 +0200 (CEST) From: Damien Cassou In-Reply-To: <87mue9sb37.fsf@gnus.org> References: <87imqw10je.fsf@cassou.me> <87mue9sb37.fsf@gnus.org> Date: Thu, 10 Oct 2019 06:15:04 +0200 Message-ID: <87ftk12q47.fsf@cassou.me> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Lars Ingebrigtsen writes: > 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). thank you! -- Damien Cassou "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill From unknown Wed Jun 18 23:12:45 2025 X-Loop: help-debbugs@gnu.org Subject: bug#37063: 26.2.90; Problems with recent CL support in checkdoc Resent-From: Glenn Morris Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 10 Oct 2019 16:47:01 +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: fixed patch To: Damien Cassou Cc: Lars Ingebrigtsen , 37063@debbugs.gnu.org, Alex Branham Received: via spool by 37063-submit@debbugs.gnu.org id=B37063.157072597820225 (code B ref 37063); Thu, 10 Oct 2019 16:47:01 +0000 Received: (at 37063) by debbugs.gnu.org; 10 Oct 2019 16:46:18 +0000 Received: from localhost ([127.0.0.1]:57042 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIbZw-0005G8-5v for submit@debbugs.gnu.org; Thu, 10 Oct 2019 12:46:16 -0400 Received: from eggs.gnu.org ([209.51.188.92]:36214) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIbZp-0005Fp-Qv for 37063@debbugs.gnu.org; Thu, 10 Oct 2019 12:46:12 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:43038) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1iIbZi-0001Wr-Se; Thu, 10 Oct 2019 12:46:03 -0400 Received: from rgm by fencepost.gnu.org with local (Exim 4.82) (envelope-from ) id 1iIbZg-00084F-Aq; Thu, 10 Oct 2019 12:46:00 -0400 From: Glenn Morris References: <87imqw10je.fsf@cassou.me> <87mue9sb37.fsf@gnus.org> <87ftk12q47.fsf@cassou.me> X-Spook: Peking National infrastructure Breach Biological event X-Ran: C,)L:,sFZ(FEpyWaiq_b4wLpQeQ)HV%RYor3,TG{GA}FB~ijG&TG"5,YnB9G_!saMgsrfM X-Hue: brightwhite X-Attribution: GM Date: Thu, 10 Oct 2019 12:45:59 -0400 In-Reply-To: <87ftk12q47.fsf@cassou.me> (Damien Cassou's message of "Thu, 10 Oct 2019 06:15:04 +0200") Message-ID: User-Agent: Gnus (www.gnus.org), GNU Emacs (www.gnu.org/software/emacs/) MIME-Version: 1.0 Content-Type: text/plain X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -1.6 (-) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.6 (--) Test failures: https://hydra.nixos.org/build/102805902 From unknown Wed Jun 18 23:12:45 2025 X-Loop: help-debbugs@gnu.org Subject: bug#37063: 26.2.90; Problems with recent CL support in checkdoc Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 11 Oct 2019 05:49: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: fixed patch To: Glenn Morris Cc: Damien Cassou , Alex Branham , 37063@debbugs.gnu.org Received: via spool by 37063-submit@debbugs.gnu.org id=B37063.15707729012644 (code B ref 37063); Fri, 11 Oct 2019 05:49:02 +0000 Received: (at 37063) by debbugs.gnu.org; 11 Oct 2019 05:48:21 +0000 Received: from localhost ([127.0.0.1]:57496 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iInmn-0000ga-7g for submit@debbugs.gnu.org; Fri, 11 Oct 2019 01:48:21 -0400 Received: from quimby.gnus.org ([80.91.231.51]:53418) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iInmk-0000gQ-LU for 37063@debbugs.gnu.org; Fri, 11 Oct 2019 01:48:19 -0400 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 1iInmh-0000rb-Is; Fri, 11 Oct 2019 07:48:17 +0200 From: Lars Ingebrigtsen References: <87imqw10je.fsf@cassou.me> <87mue9sb37.fsf@gnus.org> <87ftk12q47.fsf@cassou.me> Date: Fri, 11 Oct 2019 07:48:15 +0200 In-Reply-To: (Glenn Morris's message of "Thu, 10 Oct 2019 12:45:59 -0400") Message-ID: <878sprrfxc.fsf@gnus.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see @@CONTACT_ADDRESS@@ for details. Content preview: Glenn Morris writes: > Test failures: > > https://hydra.nixos.org/build/102805902 Should be fixed now. Content analysis details: (-2.9 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Glenn Morris writes: > Test failures: > > https://hydra.nixos.org/build/102805902 Should be fixed now. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no