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

Previous Next

Package: emacs;

Reported by: Lennart Borgman <lennart.borgman <at> gmail.com>

Date: Mon, 10 Aug 2009 21:55:05 UTC

Severity: wishlist

Tags: confirmed, fixed

Fixed in version 28.1

Done: Stefan Kangas <stefan <at> marxist.se>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Lennart Borgman <lennart.borgman <at> gmail.com>
To: Chong Yidong <cyd <at> stupidchicken.com>
Cc: 4110 <at> debbugs.gnu.org
Subject: bug#4110: 23.1.50; Checkdoc should recognize "minor mode"
Date: Mon, 14 Sep 2009 00:21:07 +0200

On Sun, Sep 13, 2009 at 10:26 PM, Chong Yidong <cyd <at> 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.
This bug report was last modified 3 years and 297 days ago.

Previous Next

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