From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Nick Dokos Newsgroups: gmane.emacs.help Subject: Re: Supplying DOC string in a `defun' using `defvar' Date: Tue, 01 Jun 2021 14:51:31 -0400 Message-ID: <874keha05o.fsf@alphaville.usersys.redhat.com> References: Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2054"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) To: help-gnu-emacs@gnu.org Cancel-Lock: sha1:OHoNRl1JpVuZWf1yoUEnMpkgzhA= Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Tue Jun 01 20:52:31 2021 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1lo9V8-0000Kw-Ov for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 01 Jun 2021 20:52:30 +0200 Original-Received: from localhost ([::1]:40332 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lo9V7-0004V6-Nk for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 01 Jun 2021 14:52:29 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53576) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lo9UM-0004Ui-6Z for help-gnu-emacs@gnu.org; Tue, 01 Jun 2021 14:51:42 -0400 Original-Received: from ciao.gmane.io ([116.202.254.214]:46540) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lo9UK-0007Jx-BJ for help-gnu-emacs@gnu.org; Tue, 01 Jun 2021 14:51:41 -0400 Original-Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1lo9UI-0009hr-F2 for help-gnu-emacs@gnu.org; Tue, 01 Jun 2021 20:51:38 +0200 X-Injected-Via-Gmane: http://gmane.org/ Received-SPF: pass client-ip=116.202.254.214; envelope-from=geh-help-gnu-emacs@m.gmane-mx.org; helo=ciao.gmane.io X-Spam_score_int: 5 X-Spam_score: 0.5 X-Spam_bar: / X-Spam_report: (0.5 / 5.0 requ) BAYES_00=-1.9, DKIM_ADSP_CUSTOM_MED=0.001, FORGED_GMAIL_RCVD=1, FREEMAIL_FORGED_FROMDOMAIN=0.248, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.249, NML_ADSP_CUSTOM_MED=0.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.23 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-mx.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.io gmane.emacs.help:130470 Archived-At: Christopher Dimech writes: >> Sent: Tuesday, June 01, 2021 at 3:26 PM >> From: "Stefan Monnier via Users list for the GNU Emacs text editor" >> To: help-gnu-emacs@gnu.org >> Subject: Re: Supplying DOC string in a `defun' using `defvar' >> >> > (defvar my-doc "Hello") >> > >> > (defun my-fun () >> > my-doc >> > (ignore)) >> > >> > It did not work, but I think it should. >> >> Try: >> >> (defvar my-doc "foobar") >> (defun (x) >> (:documentation my-doc) >> (+ x 42)) > > Have tried this but emacs is still saying "Not documented." > It should be (defun my-fun (x) ... Then try `C-h f my-fun'. -- Nick "There are only two hard problems in computer science: cache invalidation, naming things, and off-by-one errors." -Martin Fowler