From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#4110: 23.1.50; Checkdoc should recognize "minor mode" Date: Fri, 24 Sep 2021 14:45:14 -0700 Message-ID: References: <87fxaqmvzg.fsf@cyd.mit.edu> <604612c7.1c69fb81.bb823.da84@mx.google.com> <87tujbr3an.fsf@gnus.org> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="29972"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: Lennart Borgman , 4110@debbugs.gnu.org, Mauro Aranda To: Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Sep 24 23:46:15 2021 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 1mTt1K-0007W5-4r for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 24 Sep 2021 23:46:14 +0200 Original-Received: from localhost ([::1]:36668 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mTt1I-0002XN-8D for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 24 Sep 2021 17:46:12 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:39632) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mTt18-0002X5-6n for bug-gnu-emacs@gnu.org; Fri, 24 Sep 2021 17:46:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:47825) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mTt17-0008Hw-P3 for bug-gnu-emacs@gnu.org; Fri, 24 Sep 2021 17:46:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mTt17-00071S-O2 for bug-gnu-emacs@gnu.org; Fri, 24 Sep 2021 17:46:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 24 Sep 2021 21:46:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 4110 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: confirmed Original-Received: via spool by 4110-submit@debbugs.gnu.org id=B4110.163251992326918 (code B ref 4110); Fri, 24 Sep 2021 21:46:01 +0000 Original-Received: (at 4110) by debbugs.gnu.org; 24 Sep 2021 21:45:23 +0000 Original-Received: from localhost ([127.0.0.1]:59369 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mTt0U-000705-PK for submit@debbugs.gnu.org; Fri, 24 Sep 2021 17:45:22 -0400 Original-Received: from mail-pl1-f175.google.com ([209.85.214.175]:41600) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mTt0S-0006zh-Mw for 4110@debbugs.gnu.org; Fri, 24 Sep 2021 17:45:21 -0400 Original-Received: by mail-pl1-f175.google.com with SMTP id x8so4580629plv.8 for <4110@debbugs.gnu.org>; Fri, 24 Sep 2021 14:45:20 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:in-reply-to:references:user-agent :mime-version:date:message-id:subject:to:cc; bh=jh/COxzlgNQLFmx1ddEasbWFxC8sw1bXzKjPvjhO88k=; b=z2iTXZ4r6gi9AbTw7HqK1zFhE6mYBeIherkl2WgDxmbXN3mUkZuBkhY2CZVhYVHmWe 0omxI2zQEJhoKB/4IQSe6F/HsKSWpAiw89gvhEb70PmBmrhvPWN/RkN7tm3Irh44P+FC 69u6Gi7+/xapl+OdgIr5b8yi0ffPqvvW0lyoFGnAOVUGhv5Zt/JQFgl3nlE2/fLE5xTm TDN4hjC+qMeaX8RhtGdNVCbtJ04WHzJmoN/hNDUhiLiPLGTPcsrCtlED9lgc0CHf2agh 3vgaOsJL2P5EAhQxtPq/mvCKefzX1+obSdAWW7ipTahsOcyJCecQaaRkgLyarDmBEwA+ LHrg== X-Gm-Message-State: AOAM531Et4IkQJMioEFZeZcc4BM8SPGXzq5OsRP3qxmvk3Uf1gm9HeEs sYUbWyt5S3eMlCU9H3l8Od5BB8LEokM+1oeX52s= X-Google-Smtp-Source: ABdhPJxCqTHDwy90rjptw5p6KRZiPXWxnUhYSRTykot0L2S7nWdiVekXrT8ektB8HWOFoTzMOe8lSSbNQnD0agSZM4Y= X-Received: by 2002:a17:903:189:b0:13d:965f:e83f with SMTP id z9-20020a170903018900b0013d965fe83fmr11342394plg.32.1632519914853; Fri, 24 Sep 2021 14:45:14 -0700 (PDT) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Fri, 24 Sep 2021 14:45:14 -0700 In-Reply-To: <87tujbr3an.fsf@gnus.org> (Lars Ingebrigtsen's message of "Fri, 27 Aug 2021 05:10:08 +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:215342 Archived-At: tags 4110 fixed close 4110 28.1 thanks Lars Ingebrigtsen writes: > Mauro Aranda writes: > >> The change to allow this should be pretty simple: just add "mode" to the >> list of suggested words. >> >> But I do wonder if instead checkdoc should be happy just with the symbol >> ending with "-mode". IOW, I tend to think that there is no ambiguity >> in "`my-mode'" in a docstring, even if my-mode is defined as a variable >> and as a function. >> >> Any opinions? > > Yes, I think that's a good idea -- requiring "mode" before `my-mode' > seems excessive. I independently arrived at this conclusion, then I found this bug report. I agree that there is no confusion, and this check leads to a ton of such dubious warnings in the Emacs tree. So I've now fixed this on master (commit 79a9b50621).