GNU bug report logs - #6151
mystery arguments of define-minor-mode + describe-function

Previous Next

Package: emacs;

Reported by: jidanni <at> jidanni.org

Date: Mon, 10 May 2010 10:04:02 UTC

Severity: minor

Tags: notabug

Done: Lars Magne Ingebrigtsen <larsi <at> gnus.org>

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: Juanma Barranquero <lekktu <at> gmail.com>
Cc: 6151 <at> debbugs.gnu.org, jidanni <at> jidanni.org
Subject: bug#6151: mystery arguments of define-minor-mode +  describe-function
Date: Mon, 10 May 2010 13:39:06 +0200

On Mon, May 10, 2010 at 12:45 PM, Juanma Barranquero <lekktu <at> gmail.com> wrote:
> On Mon, May 10, 2010 at 12:02,  <jidanni <at> jidanni.org> wrote:
>
>> Some describe-function results add a mystery argument ARG, not visible
>> in the corresponding lisp code.
>>
>> Or maybe it is visible, but not to your average reader.
>
> Among other things, `define-minor-mode' defines a function, in this
> case longlines-mode; and that function, like all minor modes, has an
> arg to turn it on or off. So it's not `describe-function' which adds a
> "mystery argument", but the docstring for the modes, that sometimes
> lacks the relevant info.


Maybe the define-minor-mode should always add to the docstring that it
is a minor mode and provide links between the minor mod variable and
the minor mode function?
This bug report was last modified 13 years and 311 days ago.

Previous Next

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