From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs,gmane.emacs.pretest.bugs Subject: bug#702: with-help-window returns nil Date: Tue, 12 Aug 2008 11:29:53 -0700 Message-ID: <000b01c8fca9$6a98a3c0$0200a8c0@us.oracle.com> References: <48A1C81E.8050000@gmail.com> <000901c8fca5$0d3464c0$0200a8c0@us.oracle.com> <48A1D24A.6030703@gmail.com> Reply-To: Drew Adams , 702@emacsbugs.donarmstrong.com NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1218567215 11320 80.91.229.12 (12 Aug 2008 18:53:35 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 12 Aug 2008 18:53:35 +0000 (UTC) Cc: 'John Wiegley' , 702@emacsbugs.donarmstrong.com, emacs-pretest-bug@gnu.org To: "'Lennart Borgman \(gmail\)'" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Aug 12 20:54:26 2008 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1KSz0a-0002XO-HR for geb-bug-gnu-emacs@m.gmane.org; Tue, 12 Aug 2008 20:54:16 +0200 Original-Received: from localhost ([127.0.0.1]:51431 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1KSyze-0005BL-5m for geb-bug-gnu-emacs@m.gmane.org; Tue, 12 Aug 2008 14:53:18 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1KSyu5-0007Pl-8A for bug-gnu-emacs@gnu.org; Tue, 12 Aug 2008 14:47:33 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1KSyu2-0007Lr-7Q for bug-gnu-emacs@gnu.org; Tue, 12 Aug 2008 14:47:31 -0400 Original-Received: from [199.232.76.173] (port=47740 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1KSyu1-0007LA-5M for bug-gnu-emacs@gnu.org; Tue, 12 Aug 2008 14:47:29 -0400 Original-Received: from rzlab.ucr.edu ([138.23.92.77]:54634) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1KSyu0-0003CG-Ay for bug-gnu-emacs@gnu.org; Tue, 12 Aug 2008 14:47:28 -0400 Original-Received: from rzlab.ucr.edu (rzlab.ucr.edu [127.0.0.1]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id m7CIlO6g019103; Tue, 12 Aug 2008 11:47:25 -0700 Original-Received: (from debbugs@localhost) by rzlab.ucr.edu (8.13.8/8.13.8/Submit) id m7CIZAfQ015390; Tue, 12 Aug 2008 11:35:10 -0700 X-Loop: don@donarmstrong.com Resent-From: "Drew Adams" Resent-To: bug-submit-list@donarmstrong.com Resent-CC: Emacs Bugs Resent-Date: Tue, 12 Aug 2008 18:35:09 +0000 Resent-Message-ID: Resent-Sender: don@donarmstrong.com X-Emacs-PR-Message: report 702 X-Emacs-PR-Package: emacs X-Emacs-PR-Keywords: Original-Received: via spool by 702-submit@emacsbugs.donarmstrong.com id=B702.121856582314089 (code B ref 702); Tue, 12 Aug 2008 18:35:09 +0000 Original-Received: (at 702) by emacsbugs.donarmstrong.com; 12 Aug 2008 18:30:23 +0000 Original-Received: from rgminet01.oracle.com (rgminet01.oracle.com [148.87.113.118]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id m7CIUH5P013886 for <702@emacsbugs.donarmstrong.com>; Tue, 12 Aug 2008 11:30:18 -0700 Original-Received: from agmgw2.us.oracle.com (agmgw2.us.oracle.com [152.68.180.213]) by rgminet01.oracle.com (Switch-3.2.4/Switch-3.1.6) with ESMTP id m7CIUArE010667; Tue, 12 Aug 2008 12:30:10 -0600 Original-Received: from acsmt354.oracle.com (acsmt354.oracle.com [141.146.40.154]) by agmgw2.us.oracle.com (Switch-3.2.0/Switch-3.2.0) with ESMTP id m7CDJ96u012201; Tue, 12 Aug 2008 12:30:08 -0600 Original-Received: from inet-141-146-46-1.oracle.com by acsmt355.oracle.com with ESMTP id 11437470621218565779; Tue, 12 Aug 2008 11:29:39 -0700 Original-Received: from dradamslap1 (/141.144.86.2) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Tue, 12 Aug 2008 11:29:39 -0700 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: <48A1D24A.6030703@gmail.com> Thread-Index: Acj8pu4hUTBgCCMHQEyVGY/f/vGVaAAAgVCQ X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.3198 X-Brightmail-Tracker: AAAAAQAAAAI= X-Brightmail-Tracker: AAAAAQAAAAI= X-Whitelist: TRUE X-Whitelist: TRUE X-detected-kernel: by monty-python.gnu.org: Linux 2.6 (newer, 3) Resent-Date: Tue, 12 Aug 2008 14:47:31 -0400 X-BeenThere: bug-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:19327 gmane.emacs.pretest.bugs:22821 Archived-At: > >> 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'.