From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jean Louis Newsgroups: gmane.emacs.help Subject: Re: Supplying DOC string in a `defun' using `defvar' Date: Tue, 1 Jun 2021 03:35:40 +0300 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="19354"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/2.0.7+183 (3d24855) (2021-05-28) To: help-gnu-emacs@gnu.org, ludvig-faddeev@gmx.com Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Tue Jun 01 02:38:11 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 1lnsQ6-0004r7-Ms for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 01 Jun 2021 02:38:10 +0200 Original-Received: from localhost ([::1]:56314 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lnsQ5-0001EU-PH for geh-help-gnu-emacs@m.gmane-mx.org; Mon, 31 May 2021 20:38:09 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:47808) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lnsPd-0001E6-EJ for help-gnu-emacs@gnu.org; Mon, 31 May 2021 20:37:41 -0400 Original-Received: from stw1.rcdrun.com ([217.170.207.13]:58041) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lnsPb-00042i-Pg for help-gnu-emacs@gnu.org; Mon, 31 May 2021 20:37:41 -0400 Original-Received: from localhost ([::ffff:197.157.0.35]) (AUTH: PLAIN admin, TLS: TLS1.3,256bits,ECDHE_RSA_AES_256_GCM_SHA384) by stw1.rcdrun.com with ESMTPSA id 00000000000ADF01.0000000060B58151.00000A65; Mon, 31 May 2021 17:37:37 -0700 Mail-Followup-To: help-gnu-emacs@gnu.org, ludvig-faddeev@gmx.com Content-Disposition: inline In-Reply-To: Received-SPF: pass client-ip=217.170.207.13; envelope-from=bugs@gnu.support; helo=stw1.rcdrun.com X-Spam_score_int: -3 X-Spam_score: -0.4 X-Spam_bar: / X-Spam_report: (-0.4 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_SORBS_WEB=1.5, SPF_HELO_PASS=-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:130418 Archived-At: * Jean Louis [2021-06-01 03:28]: > * 2QdxY4RzWzUUiLuE@potatochowder.com <2QdxY4RzWzUUiLuE@potatochowder.com> [2021-06-01 03:15]: > > > It did not work, but I think it should. > > > > Consider the following: > > > > (defvar *string* "hello, world") > > (defun foo () > > *string*) > > > > What would foo return? What would its doc string be? > > That one did not work, it was demonstration that it does not work. > > And here again the solution which does work: > > (defvar my-doc "Hello there") > > (defmacro my-fun () > `(defun my-fun () > ,my-doc > (ignore))) > > To define function run: (my-fun) ⇒ my-fun > > (documentation 'my-fun) ⇒ "Hello there" > > Funny, as to define the function one defines macro that > overwrites itself by the function calling the macro first time. Now I wonder could it be all written this way: ;; -*- lexical-binding: t; -*- (defvar my-doc "Hello there again2") (let () (defmacro my-fun () `(defun my-fun () ,my-doc (ignore))) (my-fun)) ;; (documentation 'my-fun) ⇒ "Hello there again2" So it works that way even with lexical-binding: t But that is, while funny, not practical and not elegant, Drew's solution is there, did you read it? -- Jean Take action in Free Software Foundation campaigns: https://www.fsf.org/campaigns Sign an open letter in support of Richard M. Stallman https://stallmansupport.org/