From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: steve-humphreys@gmx.com Newsgroups: gmane.emacs.help Subject: Re: Documentation about elisp code Date: Sun, 2 May 2021 08:11:50 +0200 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="25927"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Help Gnu Emacs To: Jean Louis Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 02 08:13:46 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 1ld5MP-0006cS-0a for geh-help-gnu-emacs@m.gmane-mx.org; Sun, 02 May 2021 08:13:45 +0200 Original-Received: from localhost ([::1]:43198 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ld5MO-0004uS-3j for geh-help-gnu-emacs@m.gmane-mx.org; Sun, 02 May 2021 02:13:44 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:45752) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ld5LE-0004tk-Dc for help-gnu-emacs@gnu.org; Sun, 02 May 2021 02:12:33 -0400 Original-Received: from mout.gmx.net ([212.227.15.15]:38169) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ld5L5-0006mM-SH for help-gnu-emacs@gnu.org; Sun, 02 May 2021 02:12:32 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1619935910; bh=urkNmMH1Nve0RQuMdrQHL1OfRrBKsOcReJM2XdcQeJQ=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date:In-Reply-To:References; b=Ia8wlv/hYAcHLHCFBKqo9Jck5z3fWi+h/CamfMtAVK5RLzqalF+Id2+86i3fUrAT/ qRFOaPwKzCm17NR8DnVWtd+iJshW86hNGwg2wQ8OTTuzK1LMG8HhbnDmGwMdbBFD2g of3wQxSD8FamOweY7KmmVhApJjYm/3LjPje7MRPg= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Original-Received: from [213.165.168.94] ([213.165.168.94]) by web-mail.gmx.net (3c-app-mailcom-bs01.server.lan [172.19.170.58]) (via HTTP); Sun, 2 May 2021 08:11:50 +0200 Importance: normal Sensitivity: Normal In-Reply-To: X-UI-Message-Type: mail X-Priority: 3 X-Provags-ID: V03:K1:vEZ4kMyfWUvJyOtnAyWWIZlhN4Wm1cgtaQ2EE6TaWGktjTRyrwM4qI+xb3g+LIlHNtN3T a8X/a7kGOP04XHZHzc71aZ7z+KjUtf/5E04wKxG9jMOIqkIRG0USv7Cet5GEIyAmumOZkuB9JbRk UVUiJStWsz4EgEbGEW1O3oUzHF4VTXxSRPE13pjHEAj9jv1nlE+TBF9W+DPeg8hMk/O7Cxxr+lvi 2L/fnSdB8EDrakHXijW+QfdYJLV6zHSQsI/ef4h8twDu4JIDGQvC3WVRnKbhO1PKYaL6lXHVeODD N0= X-UI-Out-Filterresults: notjunk:1;V03:K0:Il0eNeoADNM=:FfGl72OnhOdHwVVwDY3L7p slhOe0vhnvneOrcYgqsxLRIJMVENBmlcfduUBRarcCEsuiIYZhDUfrrHi3ZTiBRxnFJmNGqDP MgzPGv0G/Eix4XSIdvotWLCrZ41OqeZ1TTNjE+DO1xiW2JShvAFdGFXsAGwZZk/ybVi4cKJyG /eU1ni4GPPBYs1cF0Mf9ThlnHVdm2qCmvYO9wND4noWg1noUnmjQf5FrmWxTDy43Q4I7TwcWS IA95e51yF7fUtSSieDquITImgLJYzqmc6UyrhckKHhsNstttiZG4nyBXL+aHCJbHb+/ioEcPg IXByUEJrFoj2g7Ll/DOPE4KRWej+Ckajiq/YNPfXLuXxGrD/Bk7dVrV+SHdFdYDaO4s2cYXZ/ lzFcy379h/Fi6XcvpGagVWYhnB8nwPoXaSXpEQ/lOT37ieZREbFVEK/ZRs7vAWfNiDEoqAfZF WVBAxsN7CtZhWpmETEd/E6tlIgYw1a4im+VRy8mzoyBRufCz6KGLsCWoWG4kGCD4RYSCyldxt roJ3r6cdfI/EWX8+5ckbUYuuNGVYHXZwFQ8qnpy32t1t8czCxShmYmWalBTESdo57+IBp8Uq/ ZCN1oW95UIA7rWZVixbJ12DX3VZAM4BUjCmP7H0JIAuDN8aqmd/7hcn5oswZLHMsRPbLR3A61 JwOwI7ty/R9DgKt/1llFIUovYPaiwrgF2nY15MNJnGmibQr18a9uRC7FCd1rNAVlLPqNi4q0W Im9EZq+nigFyfqngTxHVQxP9nLCgGHFhFJ5fjkvAx/IQSqKju5dJ2JRtIxclumabAN6ygmXI Received-SPF: pass client-ip=212.227.15.15; envelope-from=steve-humphreys@gmx.com; helo=mout.gmx.net 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, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=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:129305 Archived-At: I have coded so much stuff that I hardly remember what capabilities exist. Would really like to access an abbreviated documentation inside emacs, whilst I am hacking at things. Using manual online, or a pdf (etc) is very inconvenient. I quite like the idea of using something similar to (info "(elisp) Packaging") For instance (info "(myelisp) Topic") Is there a way for such functionality? > Sent: Sunday, May 02, 2021 at 5:31 PM > From: "Jean Louis" > To: steve-humphreys@gmx.com > Cc: "Help Gnu Emacs" > Subject: Re: Documentation about elisp code > > * 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 co= de. > > 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/ > > >