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

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.

That said, any Emacs user should be by now used to minor modes having
such an argument...

    Juanma
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.