[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#702: with-help-window returns nil

From: Drew Adams
Subject: bug#702: with-help-window returns nil
Date: Tue, 12 Aug 2008 11:29:53 -0700

> >> It is not documented that describe-function should return the 
> >> doc string.
> > 
> > And rightfully so. It does not return the doc string. It 
> > returns the content of *Help*, that is, everything that
> > is there, which includes the doc-string text.
> > See `describe-function-1' for what is included.
> > 
> > Yes, we could document that it returns the contents of 
> > *Help* as a string, but I'm not sure that would be helpful
> > to most users of `describe-funtion'. Those who are
> > concerned about the return value will likely look at the
> > source code, which already includes a comment about it.
> What is wrong with just using (documentation 'my-fun t) instead?

Instead of what?

Do you mean return that from `describe-function'? Why?

If you want that in some Lisp code, then just use that - no need to call
`describe-function'. If you want what *Help* displays for `describe-function',
however, then you can use the return value of `describe-function'.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]