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

Previous Next

Full log

View this message in rfc822 format

From: Mauro Aranda <maurooaranda <at> gmail.com>
To: 4110 <at> debbugs.gnu.org
Cc: Lennart Borgman <lennart.borgman <at> gmail.com>
Subject: bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
Date: Mon, 08 Mar 2021 09:04:19 -0300

Lennart Borgman <lennart.borgman <at> gmail.com> writes:

> You can write "function `my-mode'" or "variable `my-mode'" in a doc
> string to make checkdoc happy. However I would like to write "minor
> mode  `my-mode'" instead since it is more clear. And I think the
> `my-mode' link should go to the function since that is wher the doc
> string from define-minor-mode shows up.

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?

Previous Next

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