bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#4110: 23.1.50; Checkdoc should recognize "minor mode"


From: Mauro Aranda
Subject: bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
Date: Mon, 08 Mar 2021 09:04:19 -0300
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux)

Lennart Borgman <lennart.borgman@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?





reply via email to

[Prev in Thread] Current Thread [Next in Thread]