From: Eli Zaretskii <eliz@gnu.org>
To: help-gnu-emacs@gnu.org
Subject: Re: Documentation about elisp code
Date: Sun, 02 May 2021 10:22:02 +0300 [thread overview]
Message-ID: <835z018usl.fsf@gnu.org> (raw)
In-Reply-To: <YI45Hm42TGc2WvrZ@protected.localdomain> (message from Jean Louis on Sun, 2 May 2021 08:31:10 +0300)
> 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.
prev parent reply other threads:[~2021-05-02 7:22 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-02 4:34 Documentation about elisp code steve-humphreys
2021-05-02 5:24 ` steve-humphreys
2021-05-02 6:58 ` Tassilo Horn
2021-05-02 7:48 ` steve-humphreys
2021-05-02 8:21 ` Tassilo Horn
2021-05-02 9:07 ` steve-humphreys
2021-05-02 10:25 ` steve-humphreys
2021-05-02 10:40 ` tomas
2021-05-02 10:55 ` steve-humphreys
2021-05-02 17:00 ` Emanuel Berg via Users list for the GNU Emacs text editor
2021-05-02 23:10 ` [External] : " Drew Adams
2021-05-02 5:31 ` Jean Louis
2021-05-02 6:11 ` steve-humphreys
2021-05-02 9:08 ` Nikolay Kudryavtsev
2021-05-02 10:21 ` steve-humphreys
2021-05-02 17:03 ` Emanuel Berg via Users list for the GNU Emacs text editor
2021-05-02 7:22 ` Eli Zaretskii [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=835z018usl.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=help-gnu-emacs@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).