[External] : Supplying DOC string in a `defun' using `defvar'

[Christopher Dimech]

> 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'.)
>