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

Previous Next

Full log

Message #60 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: Wed, 03 Aug 2011 16:45:46 +0200

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

> Ah, I see the problem now.  Would the patch below have helped?
Yes, better.
Here what i have in my help buffer of help-split-fundoc:

--8<---------------cut here---------------start------------->8---
USAGE= liste des arguments de la fonction.
DOC=   Docstring de la fonction.
DEF= dans la liste des arguments (USAGE), on va avoir:
"(DEF arg1 arg2 ...)"
Si DEF est nil on aura:
"(nil arg1 arg2...)"
Autrement:
"(DEF_name arg1 arg2...)"

Exemples:
[...]
--8<---------------cut here---------------end--------------->8---

>> Idem for "def" argument.
>
> Not sure how I can improve this part.
>
>
>         Stefan
>
>
> === modified file 'lisp/help-fns.el'
> --- lisp/help-fns.el	2011-06-28 17:20:41 +0000
> +++ lisp/help-fns.el	2011-08-03 14:29:40 +0000
> @@ -102,7 +102,8 @@
>  
>  (defun help-split-fundoc (docstring def)
>    "Split a function DOCSTRING into the actual doc and the usage info.
> -Return (USAGE . DOC) or nil if there's no usage info.
> +Return (USAGE . DOC) or nil if there's no usage info, where USAGE info
> +is a string such as \"(apply FUNCTION &rest ARGUMENTS)\".
>  DEF is the function whose usage we're looking for in DOCSTRING."
>    ;; Functions can get the calling sequence at the end of the doc string.
>    ;; In cases where `function' has been fset to a subr we can't search for
>

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