From mboxrd@z Thu Jan  1 00:00:00 1970
Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail
From: Eli Zaretskii <eliz@gnu.org>
Newsgroups: gmane.emacs.help
Subject: Re: Documentation about elisp code
Date: Sun, 02 May 2021 10:22:02 +0300
Message-ID: <835z018usl.fsf@gnu.org>
References: <trinity-99beaa89-4230-4209-b5c8-853c17ccd23b-1619930040421@3c-app-mailcom-bs01>
 <YI45Hm42TGc2WvrZ@protected.localdomain>
Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214";
	logging-data="31094"; mail-complaints-to="usenet@ciao.gmane.io"
To: help-gnu-emacs@gnu.org
Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 02 09:22:42 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 1ld6R8-0007xw-Hw
	for geh-help-gnu-emacs@m.gmane-mx.org; Sun, 02 May 2021 09:22:42 +0200
Original-Received: from localhost ([::1]:47842 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 1ld6R7-0007D2-Jx
	for geh-help-gnu-emacs@m.gmane-mx.org; Sun, 02 May 2021 03:22:41 -0400
Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:54054)
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <eliz@gnu.org>) id 1ld6Qn-0007BY-33
 for help-gnu-emacs@gnu.org; Sun, 02 May 2021 03:22:21 -0400
Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:57324)
 by eggs.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <eliz@gnu.org>) id 1ld6Qm-00040n-Se
 for help-gnu-emacs@gnu.org; Sun, 02 May 2021 03:22:20 -0400
Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:2685
 helo=home-c4e4a596f7)
 by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256)
 (Exim 4.82) (envelope-from <eliz@gnu.org>) id 1ld6Qm-0002Ws-7b
 for help-gnu-emacs@gnu.org; Sun, 02 May 2021 03:22:20 -0400
In-Reply-To: <YI45Hm42TGc2WvrZ@protected.localdomain> (message from Jean Louis
 on Sun, 2 May 2021 08:31:10 +0300)
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:129311
Archived-At: <http://permalink.gmane.org/gmane.emacs.help/129311>

> Date: Sun, 2 May 2021 08:31:10 +0300
> From: Jean Louis <bugs@gnu.support>
> Cc: Help Gnu Emacs <help-gnu-emacs@gnu.org>
> 
> There are few ways to document it:
> 
> - document it inline in documentation strings and if necessary in the
>   Commentary section inside of a package;
> 
> - or create multi file package and use either README or info file or
>   other file to document it; best would be info if documentation is
>   important;

There's also the Commentary section of a .el file and the
corresponding "C-h P" command.