From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Christopher Dimech Newsgroups: gmane.emacs.help Subject: [External] : Supplying DOC string in a `defun' using `defvar' Date: Thu, 3 Jun 2021 17:34:49 +0200 Message-ID: References: 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="2705"; mail-complaints-to="usenet@ciao.gmane.io" Cc: "help-gnu-emacs@gnu.org" To: Stefan Monnier Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Thu Jun 03 17:35:27 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 1lopNX-0000PA-5R for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 03 Jun 2021 17:35:27 +0200 Original-Received: from localhost ([::1]:60768 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lopNV-0001vE-L6 for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 03 Jun 2021 11:35:25 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56096) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lopN8-0001us-AZ for help-gnu-emacs@gnu.org; Thu, 03 Jun 2021 11:35:02 -0400 Original-Received: from mout.gmx.net ([212.227.17.21]:58521) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lopN4-0006Cw-B6 for help-gnu-emacs@gnu.org; Thu, 03 Jun 2021 11:35:02 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1622734489; bh=ta1/2fZZZXVd1N5TPCc8Ff0s7mahj/f5hFE7Dd6IzvI=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date:In-Reply-To:References; b=k1feb6RQh4zINLdGyECxbd3Y1PvenbU5wiOKkR/jTVqjBd/99remQEzO00oX+fnqU 00KN5OjbuQgiQX8R7cZibZVPvmrU8BXbdl4+esWF4AOBViUyy5bw+AoNWxiHlxrmeN NUFD9W8bnRsEU1Two+ix5Kb+MPn1tkMZ8ZobOjL8= 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-bs08.server.lan [172.19.170.176]) (via HTTP); Thu, 3 Jun 2021 17:34:49 +0200 Importance: normal Sensitivity: Normal In-Reply-To: X-UI-Message-Type: mail X-Priority: 3 X-Provags-ID: V03:K1:jvIqsH0A6MJ9kQ1+miTZXTxdhSr8QlhJgUk/QtBN0pyDTbStUdvHUTi8/1Lh7l1mFafq2 uWtGHm1QlVpgoZEtk+R6pmkJ4BAK3YloU0kCXQ3sFcnKxNxEgmM/6YMbdsqjgoJ1NFqQr9+PY5jZ DUjgnKMolfsMCYiKCMktCGP7WpnUGBrcDjxmjNj/K2SugSvMARjxuDR6dXAMAlfURabVj5dGTXVR g2wV9weyjj3QdtLvM7pQXHL8NvBbRXNQbwpkK/+O40nLBAJ7nGOXBZThyoprD4D4hBno/bi/PpeR 8A= X-UI-Out-Filterresults: notjunk:1;V03:K0:XpF85l2sk98=:sWtOo23FB3RIHy0QuF5MIm 9O0Mrtf9iGpd3IZuORy3/R74r+56YK3ylAtSC/BaC5WOQ3dx9Awk2nF6D49ELmIfOPZx8B8aH J2S6zGb0ekpz3cbV5DxkXi1obHEQRL2k4bzwlrPH1pWAkn1yDX1xP38K0SiFn597qylB6jB2J 5lL/eHpWMHUMlcrpQZTPROnMrSBytEoGLD3XREx+1yESbt7F8UdcDqHZ618jk8RvOhepv/+8B IsNhd4AveZ5xQo5TqI4H5wE1tI6IvvwG4I0qmKAbp7G/LjZqkCFmFuoc9UgSb15+uNQL1/TS/ OqyzQ35nvQ7mA1Cc1aoirFkv1vsZ5JIJdrvt34YuC7kPXPicahHJpJyk9nQSecLs0xmNll5q7 on1AIPOhGDOathGS8+V6EiMO6GtufTL7Ibv1doLBnYntJhLAHrj9/tfzUv6GtO8AuJ0mBEr6Q SdkWJShsZ077znWvZK3tmLz75pK9B24L6G/J2zGS7E/KQSz9cJi5M5ndnmJJL3awqLzNpa5k5 Av7DHFeJxyl7dJoEKPa5xROTIiA9WKIOaCsZsJpgBCdMPNh2Ng5LcB6tYMr8lSj2706fuOj5p XXTqvdEZg37BomlWECPz5MsnmoVxZi4lBZ1gD63HzPABxL0r9dqKEB/R8oiQ8jzWgrovm0f70 d3maccKwXtRHJmpN7c9bt05Ds35ViPFJ2Dg13laHtoE6cDF001PeWDPQ8DnEw8RdoZArMDJ5N nSojzGTA0UhwqbJFqQqFtvbIUSJ11lwOBbADRdpTzN+rz2yLKVxeLlD43xxHpYCi9YHXMAU9 Received-SPF: pass client-ip=212.227.17.21; envelope-from=dimech@gmx.com; helo=mout.gmx.net X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=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:130533 Archived-At: > Sent: Friday, June 04, 2021 at 3:10 AM > From: "Stefan Monnier" > To: "Christopher Dimech" > Cc: "Drew Adams" , "help-gnu-emacs@gnu.org" > Subject: Re: [External] : Supplying DOC string in a `defun' using `defva= r' > > > Lars mentioned that although using :documentation works, "(:documentat= ion )" is > > a non-standard way of setting things up in contrast to something like > > "(declare (documentation ...))" > > > > What do you think? > > Most uses of this `:documentation` feature are for dynamically created > functions, and those typically don't use `defun` but something like > `defalias+lambda`. `declare`, OTOH is a property of `defun` and isn't > supported inside `lambda`, so it's not clear how that could be made > to work. > Stefan Would I need to update the :documentation declaration after the transition= to default lexical binding becomes official? It is acceptable to use the property of `defun` for the documentation. Fo= r anonymous functions, I do not think one needs elaborate ways to set the documentatio= n - a normal description is good enough.