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

Previous Next

Full log

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

From: Thierry Volpiatto <thierry.volpiatto <at> gmail.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 9115 <at> debbugs.gnu.org
Subject: Re: bug#9115: 24.0.50;
	`documentation' should not return args list for CL defun*.
Date: Tue, 19 Jul 2011 08:06:39 +0200

Hello,

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:

>> documentation return the list of arg for the defun*'s:(choose a short one)
>
>> --8<---------------cut here---------------start------------->8---
>> (documentation 'ert--remove*)
>> "Does not support all the keywords of remove*.
>
>> (fn X LIST &key KEY TEST)"
>> --8<---------------cut here---------------end--------------->8---
>
>> It's annoying for function not documented because it return only list of
>> args instead or returning nil.
>
> Yes, it's a bit inconvenient.  But if you don't want the arglist, you
> should pass the output of documentation through help-split-fundoc.
> That should then return you the nil you're looking for.
The cdr of help-split-fundoc return nil as expected for functions, CL-style
function, but always nil for macros even if they are documented.

Thus the docstring seem wrong, as it say it return nil if not
documented, which is wrong because it return a one arg list
in this case.

I had expected documentation has the same behavior for functions,
CL-style functions, and macros.

And it seem describe-function-1 is a long function that have to deal
with these inconveniences.

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