unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefan@marxist.se>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: Lennart Borgman <lennart.borgman@gmail.com>,
	4110@debbugs.gnu.org, Mauro Aranda <maurooaranda@gmail.com>
Subject: bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
Date: Fri, 24 Sep 2021 14:45:14 -0700	[thread overview]
Message-ID: <CADwFkm=ZfHidMYyiiiRDhzZHc0U9+7cJM7HaKcQkRTTROVNGSw@mail.gmail.com> (raw)
In-Reply-To: <87tujbr3an.fsf@gnus.org> (Lars Ingebrigtsen's message of "Fri, 27 Aug 2021 05:10:08 +0200")

tags 4110 fixed
close 4110 28.1
thanks

Lars Ingebrigtsen <larsi@gnus.org> writes:

> Mauro Aranda <maurooaranda@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).





  reply	other threads:[~2021-09-24 21:45 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-09-13 20:26 bug#4110: 23.1.50; Checkdoc should recognize "minor mode" Chong Yidong
2009-09-13 22:21 ` Lennart Borgman
2021-03-08 12:04   ` Mauro Aranda
2021-08-27  3:10     ` Lars Ingebrigtsen
2021-09-24 21:45       ` Stefan Kangas [this message]
  -- strict thread matches above, loose matches on Subject: below --
2009-08-10 21:49 Lennart Borgman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CADwFkm=ZfHidMYyiiiRDhzZHc0U9+7cJM7HaKcQkRTTROVNGSw@mail.gmail.com' \
    --to=stefan@marxist.se \
    --cc=4110@debbugs.gnu.org \
    --cc=larsi@gnus.org \
    --cc=lennart.borgman@gmail.com \
    --cc=maurooaranda@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).