[Top][All Lists]

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

bug#702: with-help-window returns nil

From: Lennart Borgman (gmail)
Subject: bug#702: with-help-window returns nil
Date: Tue, 12 Aug 2008 20:11:22 +0200
User-agent: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv: Gecko/20071031 Thunderbird/ Mnenhy/

Drew Adams wrote:
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?

reply via email to

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