From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: ludvig-faddeev@gmx.com Newsgroups: gmane.emacs.help Subject: Supplying DOC string in a `defun' using `defvar' Date: Tue, 1 Jun 2021 03:00:53 +0200 Message-ID: References: <87eedms9i6.fsf@web.de> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2660"; mail-complaints-to="usenet@ciao.gmane.io" 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:01:29 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 1lnsmf-0000YR-TX for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 01 Jun 2021 03:01:29 +0200 Original-Received: from localhost ([::1]:34422 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lnsme-0006fE-S1 for geh-help-gnu-emacs@m.gmane-mx.org; Mon, 31 May 2021 21:01:28 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:52736) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lnsmE-0006f3-1Q for help-gnu-emacs@gnu.org; Mon, 31 May 2021 21:01:02 -0400 Original-Received: from mout.gmx.net ([212.227.15.18]:33745) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lnsm7-0001J8-R6 for help-gnu-emacs@gnu.org; Mon, 31 May 2021 21:01:01 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1622509253; bh=eMo0rqKH6cjn+PtzoxeJwL/PkR6B3b7HLc1BtxRxkjo=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date:In-Reply-To:References; b=K8pZwDdF8m/Pxc56+434gkxlt54i8Ik/MBuUAhsP7NgXZuJZX5IVWOhodp+DuxYLY 8D+1DNQ+eYj21jfDBYlbThtI3pdP9nUEHFoBPniWaWs3euNMr4jwfmIhz/RKF70AtS pSf81SdIWZMfLdMxmyG/aJqqFykSqIjm5yRXb8+s= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Original-Received: from [213.165.168.94] ([213.165.168.94]) by web-mail.gmx.net (3c-app-mailcom-bs01.server.lan [172.19.170.58]) (via HTTP); Tue, 1 Jun 2021 03:00:53 +0200 Importance: normal Sensitivity: Normal In-Reply-To: <87eedms9i6.fsf@web.de> X-UI-Message-Type: mail X-Priority: 3 X-Provags-ID: V03:K1:rwv1razNV79sCubOWpM/hDfSO4WGnWIpKNGfVcrJcvE2laQbmvegODqPXYz8AruuyBYt1 2Q3ZMhMaY72kiFfjuQ1bPY2tAaZD+nyDuud3zLtqgrk2KhJbFfkCrvIHYTjcXh0fDU2qZSWF9n+p isA24/wdFwfZSlzNiA7Y1fV8WLA/k0W9yLo7sXx5SpkldmdrxDPRQG2dUGOK4EZrngsiSZM+zxmr faSQQhGyfK+rdhsIV+Wju1/jKlV+lxS/rnR+s3M1X6jsSk2NJ6gxtLhywmwxEo2ESndt1x/EAdVK KI= X-UI-Out-Filterresults: notjunk:1;V03:K0:andX49iRzA8=:e7dmdruy1P6yx2/1OCDXjG PmJ0oDF75K86UeUahDcr2dP9QQ779DFndWfOMYUrNXFPy/IF3NWpYbUmOpOs3oItqxZhgn6AI Tw6+T7Y79L5XjVo1VAFLCRCxHfCFccfPEBOXzgkXI7Am//C13ivfv3BpYiDdJKXpwMI3ZXBYm MHmdGZuWQ20jfWGK7jWJMcHkhBSAW29yMiCPApMdyccRsoKPYBvDGcY5zvXFUc0myLE0KgusD 14E9Kj3Ux158cx4Ew2hVIu/JNEkQWRJj0xboMKqJ0WetXjJuiTDN3UW+FsVL5glJNQyJvc+yA dW6yCq5F6253/nul5JbBUVAkLLb+5lUI2/2ypDnw5zpttEBYl3Q/vyiN22LRHj91V3r8tyUeD ZSQlONqW/aFkfYrK2Aj/CIKLS1f9jSCPRg16aF8KkXbkk7PII3cqJ279uiUGF8pJ3OASQ+Dth 20nTyKbfjS7Ot2Mk5W5oRzgG8QJhKpgmm9sY8w0e+a3ulvh5m6Yy5ktQaMJPBiciA8f1D/KC9 2CQZTDjgwakgBsIK1i+XcXroPAyMBvM5qstySjNGhusvO7eD/jxyiotPGarVnlCjjQd3D4qC0 L0SB4pyixe7h1+8bGBA0IVV3knhv2t03y9Zy4WzLkrNkKZ5lWJjwXUvagsOjJzGu2nAuCVi2w rKz90CzQ6lYsthq3Dp82n9MS9je9sZ6GRNuV7fzehWz17iWCERfQxxdkC12uzPRJR0MzrkHwO gfoXmivXLJZT+EABPlTa6Dtfc1g7OezAAs3AxJX0AP/PjeZIC3yCOCj1GhLcAwvHfWPuF5BF Received-SPF: pass client-ip=212.227.15.18; envelope-from=ludvig-faddeev@gmx.com; helo=mout.gmx.net X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham 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:130422 Archived-At: > Sent: Tuesday, June 01, 2021 at 12:40 PM > From: "Michael Heerdegen" > To: help-gnu-emacs@gnu.org > Subject: Re: Supplying DOC string in a `defun' using `defvar' > > 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? I would still want to provide it, but want to keep user centered and devel= oper centered parts to be distinct. Have worked with the literate programming = environment introduced by Knuth in the early 1980s but have not bought the result.