* bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
@ 2009-08-10 21:49 Lennart Borgman
0 siblings, 0 replies; 6+ messages in thread
From: Lennart Borgman @ 2009-08-10 21:49 UTC (permalink / raw)
To: emacs-pretest-bug
You are not allowed by checkdoc to write "minor mode `my-mode'".
Please allow that.
In GNU Emacs 23.1.50.1 (i386-mingw-nt5.1.2600)
of 2009-08-01
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4) --no-opt --cflags
-Ic:/g/include -fno-crossjumping'
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
@ 2009-09-13 20:26 Chong Yidong
2009-09-13 22:21 ` Lennart Borgman
0 siblings, 1 reply; 6+ messages in thread
From: Chong Yidong @ 2009-09-13 20:26 UTC (permalink / raw)
To: Lennart Borgman; +Cc: 4110
> You are not allowed by checkdoc to write "minor mode `my-mode'".
> Please allow that.
Please be specific.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
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
0 siblings, 1 reply; 6+ messages in thread
From: Lennart Borgman @ 2009-09-13 22:21 UTC (permalink / raw)
To: Chong Yidong; +Cc: 4110
On Sun, Sep 13, 2009 at 10:26 PM, Chong Yidong <cyd@stupidchicken.com> wrote:
>> You are not allowed by checkdoc to write "minor mode `my-mode'".
>> Please allow that.
>
> Please be specific.
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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
2009-09-13 22:21 ` Lennart Borgman
@ 2021-03-08 12:04 ` Mauro Aranda
2021-08-27 3:10 ` Lars Ingebrigtsen
0 siblings, 1 reply; 6+ messages in thread
From: Mauro Aranda @ 2021-03-08 12:04 UTC (permalink / raw)
To: 4110; +Cc: Lennart Borgman
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?
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
2021-03-08 12:04 ` Mauro Aranda
@ 2021-08-27 3:10 ` Lars Ingebrigtsen
2021-09-24 21:45 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Lars Ingebrigtsen @ 2021-08-27 3:10 UTC (permalink / raw)
To: Mauro Aranda; +Cc: 4110, Lennart Borgman
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.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
2021-08-27 3:10 ` Lars Ingebrigtsen
@ 2021-09-24 21:45 ` Stefan Kangas
0 siblings, 0 replies; 6+ messages in thread
From: Stefan Kangas @ 2021-09-24 21:45 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: Lennart Borgman, 4110, Mauro Aranda
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).
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-09-24 21:45 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
-- strict thread matches above, loose matches on Subject: below --
2009-08-10 21:49 Lennart Borgman
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).