From unknown Fri Jun 20 07:22:24 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#69226 <69226@debbugs.gnu.org> To: bug#69226 <69226@debbugs.gnu.org> Subject: Status: 29.2.50; elisp-flymake-checkdoc complains about mentioning defclass Reply-To: bug#69226 <69226@debbugs.gnu.org> Date: Fri, 20 Jun 2025 14:22:24 +0000 retitle 69226 29.2.50; elisp-flymake-checkdoc complains about mentioning de= fclass reassign 69226 emacs submitter 69226 Spencer Baugh severity 69226 normal thanks From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 18 13:24:07 2024 Received: (at submit) by debbugs.gnu.org; 18 Feb 2024 18:24:07 +0000 Received: from localhost ([127.0.0.1]:37285 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rblpe-0003IT-8R for submit@debbugs.gnu.org; Sun, 18 Feb 2024 13:24:06 -0500 Received: from lists.gnu.org ([209.51.188.17]:53956) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rblSL-0001mW-3I for submit@debbugs.gnu.org; Sun, 18 Feb 2024 13:00:02 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rb08B-0002s0-FN for bug-gnu-emacs@gnu.org; Fri, 16 Feb 2024 10:28:03 -0500 Received: from mxout2.mail.janestreet.com ([38.105.200.79]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rb089-0006No-Tp for bug-gnu-emacs@gnu.org; Fri, 16 Feb 2024 10:28:03 -0500 From: Spencer Baugh To: bug-gnu-emacs@gnu.org Subject: 29.2.50; elisp-flymake-checkdoc complains about mentioning defclass Date: Fri, 16 Feb 2024 10:28:00 -0500 Message-ID: MIME-Version: 1.0 Content-Type: text/plain DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=janestreet.com; s=waixah; t=1708097280; bh=EJ9WR5cWueipMhBBHhSA1r5pzAsnHX7pklP41nu1I/Y=; h=From:To:Cc:Subject:Date; b=Sbmw9mWFBNkFP21nkNj5VX/+wIeyrZNgbw1qb5ef0uB4C2DWkYD4AlhzK8YO+HcWL djjntwiFw3hWiRbyMJReWALsiceWIMTe6XGJiPV4HtFd2k+med/guuD3Y2ZprU6dmC AmF73j43oWVzWvVWyufwUvjiJLsF4hrqFBuEnzQLJBpfK1jcJcoTCIulbTfeFNqgw3 1zjp1vJnmIdDnfTccaow3B+V4tmKbc1eP8Fdl/2mm0MiOW7yfeDYH1vRO7oopRM5Nq Wzkfju3Zf1reanNMMWdyhtKf9r+PlGQmDXUgVdihpl/23QapgA8yRWND+jku7/oO+4 OpAmyCGJ4SBpg== Received-SPF: pass client-ip=38.105.200.79; envelope-from=sbaugh@janestreet.com; helo=mxout2.mail.janestreet.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -4.2 (----) X-Debbugs-Envelope-To: submit Cc: Eric Ludlam , Stefan Kangas 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: -5.2 (-----) 1. emacs -Q 2. Create file containing: (defclass my-class () ()) (defvar my-value nil "A useful value. Should be of type `my-class' or nil") (defun my-func () "Does something. The return value is of type `my-class'.") 3. M-x flymake-mode 4. Observe warnings about: Disambiguate my-class by preceding w/ function,command,variable,option or symbol. The issue is that `my-class' is both a variable and a function. I could rewrite the docstrings to say "Should be produced by the function `my-class', or nil." "The return value is produced by calling the function `my-class'." but that's awkward wording. It would be nice if checkdoc would recognize "type" before a quoted symbol as removing the ambiguity. Also, it might be nice if the docstring parser recognized "type" as indicating that it should link to the function definition, not the variable definition, since the variable definition is deprecated anyway. In GNU Emacs 29.2.50 (build 2, x86_64-pc-linux-gnu, X toolkit, cairo version 1.15.12, Xaw scroll bars) of 2024-01-24 built on igm-qws-u22796a Repository revision: 09ba5f12dd85cdff266b9bbb3f8510abdfd67a62 Repository branch: emacs-29 Windowing system distributor 'The X.Org Foundation', version 11.0.12011000 System Description: Rocky Linux 8.9 (Green Obsidian) Configured using: 'configure 'CFLAGS=-O0 -g3' --with-gif=ifavailable --with-x-toolkit=lucid' Configured features: CAIRO DBUS FREETYPE GLIB GMP GNUTLS GSETTINGS HARFBUZZ JPEG JSON LIBSELINUX LIBSYSTEMD LIBXML2 MODULES NOTIFY INOTIFY PDUMPER PNG RSVG SECCOMP SOUND SQLITE3 THREADS TIFF TOOLKIT_SCROLL_BARS X11 XDBE XIM XINPUT2 XPM LUCID ZLIB Important settings: value of $LANG: en_US.UTF-8 locale-coding-system: utf-8-unix Major mode: Info Memory information: ((conses 16 2072917 190283) (symbols 48 66336 0) (strings 32 350168 31566) (string-bytes 1 15047792) (vectors 16 134982) (vector-slots 8 2606522 206024) (floats 8 946 592) (intervals 56 118464 832) (buffers 976 333))