From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Michael Heerdegen Newsgroups: gmane.emacs.help Subject: Re: describe-mode "some-mode": (documentation some-mode) Date: Sun, 31 Aug 2014 00:30:21 +0200 Message-ID: <87r3zxipaa.fsf@web.de> References: <87bnrc1lkz.fsf@yun.yagibdah.de> <87tx54mjmm.fsf@debian.uxu> <87lhqflwb6.fsf_-_@debian.uxu> <878umek5fv.fsf@debian.uxu> <87ha0u9paj.fsf@yun.yagibdah.de> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1409437876 32464 80.91.229.3 (30 Aug 2014 22:31:16 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 30 Aug 2014 22:31:16 +0000 (UTC) To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Sun Aug 31 00:31:08 2014 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1XNrAl-0005AV-G9 for geh-help-gnu-emacs@m.gmane.org; Sun, 31 Aug 2014 00:31:03 +0200 Original-Received: from localhost ([::1]:47948 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XNrAl-0007sO-2x for geh-help-gnu-emacs@m.gmane.org; Sat, 30 Aug 2014 18:31:03 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:33457) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XNrAU-0007rk-Gy for help-gnu-emacs@gnu.org; Sat, 30 Aug 2014 18:30:52 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XNrAO-0002oP-8z for help-gnu-emacs@gnu.org; Sat, 30 Aug 2014 18:30:46 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:38986) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XNrAO-0002oK-1w for help-gnu-emacs@gnu.org; Sat, 30 Aug 2014 18:30:40 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1XNrAL-0004m9-P7 for help-gnu-emacs@gnu.org; Sun, 31 Aug 2014 00:30:37 +0200 Original-Received: from ip-90-186-27-165.web.vodafone.de ([90.186.27.165]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 31 Aug 2014 00:30:37 +0200 Original-Received: from michael_heerdegen by ip-90-186-27-165.web.vodafone.de with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 31 Aug 2014 00:30:37 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 32 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: ip-90-186-27-165.web.vodafone.de User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.92 (gnu/linux) Cancel-Lock: sha1:P9k9gDUIvM0JZirgwXQvYoLj4c8= X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 80.91.229.3 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.help:99543 Archived-At: lee writes: > >> (defun my-describe-mode () "Display the documentation > >> of MODE." (interactive) (let ((mode (list (intern > >> (read-string "Mode: "))))) (unless (functionp mode) > >> (with-current-buffer (switch-to-buffer-other-window > >> "my-describe-mode") (insert (documentation mode)))))) > >> > >> This inserts "Keyboard macro." into the buffer > >> (without the quotes). I'm not too sure about what I'm > >> doing here ... > Instead of returning the docstring for the mode, (insert (documentation > mode)) inserts "Keybaord macro." into the buffer with the function I > defined to do this. > > I'm wondering why apparently (documentation mode) returns "Keyboard > macro." instead of the docstring ... It doesn't. You bind `mode' to a list (!) of one element, the function. You want to bind `mode' to the function itself. (OTOH, for the interactive spec, you would want to return a list: the list of read arguments, which are then bound to the argument variables.) And then, `unless' should be a `when'. > What's the defined or supposed behaviour of 'insert when the buffer to > insert something into is read-only? Raising an error. Michael.