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 04:07:18 +0300 Message-ID: References: <87eedms9i6.fsf@web.de> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="32921"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/2.0.7+183 (3d24855) (2021-05-28) Cc: help-gnu-emacs@gnu.org To: Michael Heerdegen Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Tue Jun 01 03:08: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 1lnst9-0008Ml-Bm for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 01 Jun 2021 03:08:11 +0200 Original-Received: from localhost ([::1]:35460 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lnst8-0007kW-8V for geh-help-gnu-emacs@m.gmane-mx.org; Mon, 31 May 2021 21:08:10 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:54532) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lnssg-0007kL-K5 for help-gnu-emacs@gnu.org; Mon, 31 May 2021 21:07:42 -0400 Original-Received: from stw1.rcdrun.com ([217.170.207.13]:55511) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lnsse-0005WG-Jq for help-gnu-emacs@gnu.org; Mon, 31 May 2021 21:07:42 -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.0000000060B58859.00000C97; Mon, 31 May 2021 18:07:37 -0700 Mail-Followup-To: Michael Heerdegen , help-gnu-emacs@gnu.org Content-Disposition: inline In-Reply-To: <87eedms9i6.fsf@web.de> 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:130423 Archived-At: * Michael Heerdegen [2021-06-01 03:40]: > Jean Louis writes: > > > (defvar my-doc "Hello there") > > > > (defmacro my-fun () > > `(defun my-fun () > > ,my-doc > > (ignore))) > > Would you want the body to be stored in another defvar? Then your code > would be even smaller. > > I'm only partially joking, actually, not at all - is the function's > documentation for your code's readers really that much less important > than its code? Maybe it's even the other way round? Yes, obviously it is not practical, but it works. And is not me who defines those functions. I am generating 50+ function aliases by Drew's suggestion: (defun hyperscope-generate-add-functions-by-hyperdocument-types () (let ((types (hyperscope-hyperdocument-types))) (while types (let* ((type (pop types)) (id (nth 0 type)) (type (nth 1 type)) (type-name type) (type (downcase (string-replace " " "-" type))) (new-function-name (format "hyperscope-add-new-%s-hyperdocument" type))) (defalias (intern new-function-name) (lambda () (interactive) (let* ((parent (hyperscope-select-set)) (prompt (format "New `%s' hyperdocument name: " type-name)) (name (read-from-minibuffer prompt))) (hlink-add-generic name "" id parent nil))) (format "Add new `%s' hyperdocument to Hyperscope." type-name)))))) (hyperscope-generate-add-functions-by-hyperdocument-types) This technique is handy as then user can simply add new type in the database, visually, interactively, and new function is generated as a hook that helps to add the new type. Even new key binding could be generated automatically. -- 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/