GNU bug report logs - #13800
24.3.50; About an example in "(elisp) Writing Emacs Primitives"

Previous Next

Full log

Message #8 received at 13800 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Xue Fuqiao <xfq.free <at> gmail.com>
Cc: 13800 <at> debbugs.gnu.org
Subject: Re: bug#13800: 24.3.50;
	About an example in "(elisp) Writing Emacs Primitives"
Date: Sun, 24 Feb 2013 17:05:09 +0200

> Date: Sun, 24 Feb 2013 14:55:48 +0800
> From: Xue Fuqiao <xfq.free <at> gmail.com>
> 
> 
> In (info "(elisp) Writing Emacs Primitives"):
> 
> INTERACTIVE
>      This is an interactive specification, a string such as might be
>      used as the argument of `interactive' in a Lisp function.  In the
>      case of `or', it is 0 (a null pointer), indicating that `or'
>      cannot be called interactively.  A value of `""' indicates a
>      function that should receive no arguments when called
>      interactively.  If the value begins with a `(', the string is
>      evaluated as a Lisp form.  For examples of the last two forms, see
>      `widen' and `narrow-to-region' in `editfns.c'.
> 
> In the last sentence, neither the INTERACTIVE of the example primitive
> `widen' nor `narrow-to-region' begins with a `('.  I think
> `narrow-to-region' should be replaced by primitives like `insert-char'
> instead.

And then, a few years later, someone else will say that the same
happened with insert-char, yes?

I'd rather suggest to remove any references to the sources, as that is
a source of constant maintenance pains and inaccuracies in the docs.
Instead, I suggest to add to the manual an example of such a DEFUN
declaration.

Previous Next

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