Re: Supplying DOC string in a `defun' using `defvar'

[Nick Dokos]

Christopher Dimech <dimech@gmx.com> writes:

>> Sent: Tuesday, June 01, 2021 at 3:26 PM

>> From: "Stefan Monnier via Users list for the GNU Emacs text editor" 
>> <help-gnu-emacs@gnu.org>
>> To: help-gnu-emacs@gnu.org
>> Subject: Re: Supplying DOC string in a `defun' using `defvar'
>>
>> > (defvar my-doc "Hello")
>> >
>> > (defun my-fun ()
>> >   my-doc
>> >   (ignore))
>> >
>> > It did not work, but I think it should.
>>
>> Try:
>>
>>     (defvar my-doc "foobar")
>>     (defun (x)
>>       (:documentation my-doc)
>>       (+ x 42))
>
> Have tried this but emacs is still saying "Not documented."
>

It should be

  (defun my-fun (x)
     ...

Then try `C-h f my-fun'.
-- 
Nick

"There are only two hard problems in computer science: cache
invalidation, naming things, and off-by-one errors." -Martin Fowler