From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jean Louis Newsgroups: gmane.emacs.help Subject: Re: Documentation about elisp code Date: Sun, 2 May 2021 08:31:10 +0300 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="15663"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/2.0.6 (2021-03-06) Cc: Help Gnu Emacs To: steve-humphreys@gmx.com Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 02 07:41:51 2021 Return-path: 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 ) id 1ld4rX-0003yv-Me for geh-help-gnu-emacs@m.gmane-mx.org; Sun, 02 May 2021 07:41:51 +0200 Original-Received: from localhost ([::1]:57498 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ld4rW-0002wa-Ql for geh-help-gnu-emacs@m.gmane-mx.org; Sun, 02 May 2021 01:41:50 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:41374) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ld4pN-0002um-Nl for help-gnu-emacs@gnu.org; Sun, 02 May 2021 01:39:38 -0400 Original-Received: from stw1.rcdrun.com ([217.170.207.13]:45529) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ld4pA-0002FL-Ho for help-gnu-emacs@gnu.org; Sun, 02 May 2021 01:39:34 -0400 Original-Received: from localhost ([::ffff:154.227.44.235]) (AUTH: PLAIN securesender, TLS: TLS1.3,256bits,ECDHE_RSA_AES_256_GCM_SHA384) by stw1.rcdrun.com with ESMTPSA id 00000000000462BB.00000000608E3AE5.00003949; Sat, 01 May 2021 22:38:44 -0700 Mail-Followup-To: steve-humphreys@gmx.com, Help Gnu Emacs Content-Disposition: inline In-Reply-To: Received-SPF: pass client-ip=217.170.207.13; envelope-from=bugs@gnu.support; helo=stw1.rcdrun.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.io gmane.emacs.help:129302 Archived-At: * steve-humphreys@gmx.com [2021-05-02 07:34]: > What would be a good strategy to use for displaying some documentation > regarding some elisp code I have written. > > Naturally, I included documentation strings in my defuns. But there > is no information about learning the functionalities provided by my code. I recommend reading about: (info "(elisp) Packaging") 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; -- Jean Take action in Free Software Foundation campaigns: https://www.fsf.org/campaigns Sign an open letter in support of Richard M. Stallman https://stallmansupport.org/ https://rms-support-letter.github.io/