GNU bug report logs - #9115
`documentation' should let you choose whether to include `usage'

Previous Next

Full log

View this message in rfc822 format

From: Thierry Volpiatto <thierry.volpiatto <at> gmail.com>
To: 9115 <at> debbugs.gnu.org
Subject: bug#9115: 24.0.50; `documentation' should not return args list for CL defun*.
Date: Mon, 18 Jul 2011 09:18:23 +0200

Leo <sdl.web <at> gmail.com> writes:

> On 2011-07-18 14:05 +0800, Thierry Volpiatto wrote:
>> documentation return the list of arg for the defun*'s:(choose a short one)
>>
>> (documentation 'ert--remove*)
>> "Does not support all the keywords of remove*.
>>
>> (fn X LIST &key KEY TEST)"
>>
>> It's annoying for function not documented because it return only list of
>> args instead or returning nil.
>
> Check the expansion of defun*; it always has a doc-string.
What expansion?

if you have:

--8<---------------cut here---------------start------------->8---
(defun* foo (&rest args) nil)
(documentation 'foo)
Give ==>
"

(fn &rest ARGS)"
--8<---------------cut here---------------end--------------->8---

which is wrong.

--8<---------------cut here---------------start------------->8---
(defun bar (&rest args) nil)
(documentation 'bar)
Give ==>nil
--8<---------------cut here---------------end--------------->8---

Which is correct.

-- 
A+ Thierry
Get my Gnupg key:
gpg --keyserver pgp.mit.edu --recv-keys 59F29997 

Previous Next

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