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: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 9115 <at> debbugs.gnu.org
Subject: bug#9115: 24.0.50; `documentation' should not return args list for CL defun*.
Date: Tue, 02 Aug 2011 07:21:15 +0200

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

>>> 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.
>
> Hmm... I don't understand: help-split-fundoc doesn't care if the
> docstring comes from a function, a macro, or a mushroom.  Or maybe
> I don't understand what you're saying.  Can you show some detail of what
> you do?

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

(defun bar (&rest args) nil)
(help-split-fundoc (documentation 'bar) nil)
=>nil

(defmacro foo-1 (&rest args) "some doc." nil)
(help-split-fundoc (documentation 'foo-1) nil)
nil
--8<---------------cut here---------------end--------------->8---

But same here, it's ok i finally parse myself th output of documentation
to extract the first line, it works fine.(so i don't use
help-split-fundoc)


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