[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[External] : Supplying DOC string in a `defun' using `defvar'
From: |
Christopher Dimech |
Subject: |
[External] : Supplying DOC string in a `defun' using `defvar' |
Date: |
Tue, 1 Jun 2021 17:05:45 +0200 |
> Sent: Wednesday, June 02, 2021 at 3:01 AM
> From: "Drew Adams" <drew.adams@oracle.com>
> To: "Christopher Dimech" <dimech@gmx.com>, "Michael Heerdegen"
> <michael_heerdegen@web.de>
> Cc: "help-gnu-emacs@gnu.org" <help-gnu-emacs@gnu.org>
> Subject: RE: [External] : Supplying DOC string in a `defun' using `defvar'
>
> > > (defun my-fun (x)
> > > (:documentation my-doc)
> > > (+ x 42))
> >
> > Had noticed what happened, but (:documentation my-doc) is not taking effect
> > and get "function not documented".
>
> It works for me. However, at least in Emacs 27.2,
> `:documentation' is not documented in the Elisp manual,
> except for use by `cl-generic'. That seems like a bug.
I have used emacs-27.1 and emacs-28.0.50. Doing "C-h f my-fun"
gives
--------
my-fun is an interactive Lisp function in ‘gungadin.el’.
(my-fun X)
Not documented.
---------
> (But `:doc' is documented, for use by `defcustom'.
> And grepping shows that there is also `:doc-spec'.)
>
- Supplying DOC string in a `defun' using `defvar', Christopher Dimech, 2021/06/01
- Re: Supplying DOC string in a `defun' using `defvar', Michael Heerdegen, 2021/06/01
- Supplying DOC string in a `defun' using `defvar', Christopher Dimech, 2021/06/01
- RE: [External] : Supplying DOC string in a `defun' using `defvar', Drew Adams, 2021/06/01
- [External] : Supplying DOC string in a `defun' using `defvar',
Christopher Dimech <=
- Re: [External] : Supplying DOC string in a `defun' using `defvar', Stefan Monnier, 2021/06/01
- [External] : Supplying DOC string in a `defun' using `defvar', Christopher Dimech, 2021/06/01
- Re: [External] : Supplying DOC string in a `defun' using `defvar', Eli Zaretskii, 2021/06/01
- [External] : Supplying DOC string in a `defun' using `defvar', Christopher Dimech, 2021/06/01
- Re: [External] : Supplying DOC string in a `defun' using `defvar', Stefan Monnier, 2021/06/01
- Re: [External] : Supplying DOC string in a `defun' using `defvar', Michael Heerdegen, 2021/06/02
- [External] : Supplying DOC string in a `defun' using `defvar', Christopher Dimech, 2021/06/02
- Re: [External] : Supplying DOC string in a `defun' using `defvar', Jean Louis, 2021/06/03
- Re: [External] : Supplying DOC string in a `defun' using `defvar', Eduardo Ochs, 2021/06/03
- Re: [External] : Supplying DOC string in a `defun' using `defvar', Jean Louis, 2021/06/03