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: Tue, 1 Jun 2021 17:05:45 +0200 Message-ID: References: <871r9ly7v3.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="5202"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Michael Heerdegen , "help-gnu-emacs@gnu.org" To: Drew Adams Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Tue Jun 01 17:28:14 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 1lo6JS-00016m-1D for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 01 Jun 2021 17:28:14 +0200 Original-Received: from localhost ([::1]:38104 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lo6JQ-0002ls-QI for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 01 Jun 2021 11:28:12 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37976) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lo5xq-00031z-2A for help-gnu-emacs@gnu.org; Tue, 01 Jun 2021 11:05:55 -0400 Original-Received: from mout.gmx.net ([212.227.15.15]:48263) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lo5xm-0005NZ-9z for help-gnu-emacs@gnu.org; Tue, 01 Jun 2021 11:05:53 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1622559945; bh=CaIYtoe9Glgs+sGIp7h4alMzVpeyqUbaScGTRpEIg7s=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date:In-Reply-To:References; b=bZ4RiBFru8i2Ea/1LVYfkQ2evf65DDr66ww6nBMBpFAXB5Gx4gIB5pPgwJbNm4QjG n3njtl+YO3c/GbLefsyF2yZk/6Em1TB31SJhMU7Hv9ARyGlYkD4gST7FwN73RCF5Bf uuHPXQUlxImmON4TfRtzYc2+xfX7eKizJLabOOJk= 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 17:05:45 +0200 Importance: normal Sensitivity: Normal In-Reply-To: X-UI-Message-Type: mail X-Priority: 3 X-Provags-ID: V03:K1:yVS7yPtUt8HSf8aeSPtmCwWfMYOK8J/xm9kkV3pODT5YQMzVPaxeobAEMbhHK3ibfKxHb VJiVRj0hUiJNStQbFNlkDr4Inp93QWG+WXdRnDR03eH0z65I/h6gs5Jy79eSJ0v2TdBxGEA/LaYY RcYf5eFHwAla7tdJsdzCyYepHcEtAdoOjiv/9sr+pYUqR9nOl5GHF5204JlKRuNJF/FsxieRjuO0 2nkQhZpuLbsG8rrDUL/myY1RiQgc9ja+Tb626kKEBjCpXZOjaWe+d/awYxAlze+cMYw4QhdyYtoe bQ= X-UI-Out-Filterresults: notjunk:1;V03:K0:JnOBfPeqXnw=:Q59zpt5v7V6/01dBdovy00 hnfqY99Aok8NlM0s2Resi44bVA8l/p0gVx5JXKr+M+pdzyo75CF7T379VrGFPBvu77lkoolvc fZLeU2dVt0wZXN5IM5MiEeEKaCMhEdl87Afiu+KNVwY8+zvhXfiDp6f5bTOspCOunJfpN3IdM Cg6eecPu/Kfvmr+VG86XJgyqDUMDRJA6RaQ+XyHNifaq2l3mKwhLX95Jxntq/9kKf/Ce8othG d3BM+mCVEeFCcq2qdxiXbEtNT5dpzQFqzUv0F24Waj9Sr5LDg10YYckvS1FbaJWGbLpFjsX4O NMLJb7/skbk8J71qypvW7HwB8no1VuZZbwE2u3VYFlyBDudVjAircFo1t09J8C2Q3D74OQyVy jqhkXZwBbhVdvedtNks/90FbWzQzQOLnifA5KTOn+p/97um7rjFfhrpHAZ8YyGiRSGrkSq2jp BNZlHQZ3TKCfNcDUja7Q2rQp4zyaonmlqksZ7ifMa5DhctqGwWYRfm0/STS16Yc+6+SKqNw43 iDP0t38uuL3gvyU2QoqHtfl2prXxXJpI7/Q5zRUxpeeJFud6T4wwFEIk/iOJbxtaAJyEjtVim +CNe80ELF6m+BWn8omWXdLQODcUBh2QCmErNJcHcCZ0TXTYnrlge6vetEchb3CS1mqWTTWNr/ oNslQ/q8K2IhaA2spcTtOipeof6dTCnGRItxoSSJJfjrW6dW8oYxNz4+iQB4Sn/oIB8z5kuD7 K+uMv3kZ9bG9oYJBuCi2gWnrDcYpg0umO6ZAEU8oexkhi7qWYqpCLwzN/s3mw3VJ4tOy5MpG Received-SPF: pass client-ip=212.227.15.15; 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:130456 Archived-At: > Sent: Wednesday, June 02, 2021 at 3:01 AM > From: "Drew Adams" > To: "Christopher Dimech" , "Michael Heerdegen" > Cc: "help-gnu-emacs@gnu=2Eorg" > Subject: RE: [External] : Supplying DOC string in a `defun' using `defva= r' > > > > (defun my-fun (x) > > > (:documentation my-doc) > > > (+ x 42)) > >=20 > > Had noticed what happened, but (:documentation my-doc) is not taking e= ffect > > and get "function not documented"=2E >=20 > It works for me=2E However, at least in Emacs 27=2E2, > `:documentation' is not documented in the Elisp manual, > except for use by `cl-generic'=2E That seems like a bug=2E I have used emacs-27=2E1 and emacs-28=2E0=2E50=2E Doing "C-h f my-fun" gives -------- my-fun is an interactive Lisp function in =E2=80=98gungadin=2Eel=E2=80=99= =2E (my-fun X) Not documented=2E --------- =20 > (But `:doc' is documented, for use by `defcustom'=2E > And grepping shows that there is also `:doc-spec'=2E) >