From mboxrd@z Thu Jan  1 00:00:00 1970
Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail
From: Stefan Monnier via Users list for the GNU Emacs text editor <help-gnu-emacs@gnu.org>
Newsgroups: gmane.emacs.help
Subject: Re: Supplying DOC string in a `defun' using `defvar'
Date: Mon, 31 May 2021 23:26:29 -0400
Message-ID: <jwvbl8qmfkc.fsf-monnier+emacs@gnu.org>
References: <trinity-90d53942-c0cd-437d-b9af-5b3f1ba9e76e-1622502005218@3c-app-mailcom-bs01>
 <YLVtfINYzywDoHwr@protected.localdomain>
Reply-To: Stefan Monnier <monnier@iro.umontreal.ca>
Mime-Version: 1.0
Content-Type: text/plain
Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214";
	logging-data="22970"; mail-complaints-to="usenet@ciao.gmane.io"
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux)
To: help-gnu-emacs@gnu.org
Cancel-Lock: sha1:OO9kEAU+AJWGdYfkaDH7v9psl+w=
Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Tue Jun 01 05:27:01 2021
Return-path: <help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org>
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 <help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org>)
	id 1lnv3V-0005qg-9I
	for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 01 Jun 2021 05:27:01 +0200
Original-Received: from localhost ([::1]:48046 helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org>)
	id 1lnv3U-0000Jj-9X
	for geh-help-gnu-emacs@m.gmane-mx.org; Mon, 31 May 2021 23:27:00 -0400
Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:59606)
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <geh-help-gnu-emacs@m.gmane-mx.org>)
 id 1lnv39-0000JW-3y
 for help-gnu-emacs@gnu.org; Mon, 31 May 2021 23:26:39 -0400
Original-Received: from ciao.gmane.io ([116.202.254.214]:49462)
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <geh-help-gnu-emacs@m.gmane-mx.org>)
 id 1lnv37-000186-ML
 for help-gnu-emacs@gnu.org; Mon, 31 May 2021 23:26:38 -0400
Original-Received: from list by ciao.gmane.io with local (Exim 4.92)
 (envelope-from <geh-help-gnu-emacs@m.gmane-mx.org>)
 id 1lnv34-0005LB-J6
 for help-gnu-emacs@gnu.org; Tue, 01 Jun 2021 05:26:34 +0200
X-Injected-Via-Gmane: http://gmane.org/
Received-SPF: pass client-ip=116.202.254.214;
 envelope-from=geh-help-gnu-emacs@m.gmane-mx.org; helo=ciao.gmane.io
X-Spam_score_int: -16
X-Spam_score: -1.7
X-Spam_bar: -
X-Spam_report: (-1.7 / 5.0 requ) BAYES_00=-1.9,
 HEADER_FROM_DIFFERENT_DOMAINS=0.249, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001 autolearn=no 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 <help-gnu-emacs.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/help-gnu-emacs>,
 <mailto:help-gnu-emacs-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/help-gnu-emacs>
List-Post: <mailto:help-gnu-emacs@gnu.org>
List-Help: <mailto:help-gnu-emacs-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/help-gnu-emacs>,
 <mailto:help-gnu-emacs-request@gnu.org?subject=subscribe>
Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org
Original-Sender: "help-gnu-emacs"
 <help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org>
Xref: news.gmane.io gmane.emacs.help:130430
Archived-At: <http://permalink.gmane.org/gmane.emacs.help/130430>

> (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))


-- Stefan