From: "Lennart Borgman (gmail)" <lennart.borgman@gmail.com>
To: Drew Adams <drew.adams@oracle.com>
Cc: 'John Wiegley' <johnw@newartisans.com>,
702@emacsbugs.donarmstrong.com, emacs-pretest-bug@gnu.org
Subject: bug#702: with-help-window returns nil
Date: Tue, 12 Aug 2008 20:11:22 +0200 [thread overview]
Message-ID: <48A1D24A.6030703@gmail.com> (raw)
In-Reply-To: <000901c8fca5$0d3464c0$0200a8c0@us.oracle.com>
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?
next prev parent reply other threads:[~2008-08-12 18:11 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-08-12 16:52 bug#702: with-help-window returns nil Glenn Morris
2008-08-12 17:27 ` Lennart Borgman (gmail)
2008-08-12 17:58 ` Drew Adams
2008-08-12 18:11 ` Lennart Borgman (gmail) [this message]
2008-08-12 18:29 ` Drew Adams
-- strict thread matches above, loose matches on Subject: below --
2008-08-13 5:52 martin rudalics
2008-08-13 16:50 ` Glenn Morris
2008-08-13 17:05 ` martin rudalics
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=48A1D24A.6030703@gmail.com \
--to=lennart.borgman@gmail.com \
--cc=702@emacsbugs.donarmstrong.com \
--cc=drew.adams@oracle.com \
--cc=emacs-pretest-bug@gnu.org \
--cc=johnw@newartisans.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.