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: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Thierry Volpiatto <thierry.volpiatto <at> gmail.com>
Cc: 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 12:02:26 -0400

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


        Stefan

Previous Next

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