GNU bug report logs - #4110
23.1.50; Checkdoc should recognize "minor mode"

Previous Next

Full log

Message #34 received at control <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 4110 <at> debbugs.gnu.org, Lennart Borgman <lennart.borgman <at> gmail.com>,
 Mauro Aranda <maurooaranda <at> gmail.com>
Subject: Re: bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
Date: Fri, 24 Sep 2021 14:45:14 -0700

tags 4110 fixed
close 4110 28.1
thanks

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Mauro Aranda <maurooaranda <at> gmail.com> 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).

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.