From: Alexis <flexibeast@gmail.com>
To: help-gnu-emacs <help-gnu-emacs@gnu.org>
Subject: Re: Packages, release notes, etc
Date: Thu, 10 Sep 2015 21:40:31 +1000 [thread overview]
Message-ID: <87mvwu4i4w.fsf@gmail.com> (raw)
In-Reply-To: 87io7iochh.fsf@gnu.org
Tassilo Horn <tsdh@gnu.org> writes:
> Things like a ChangeLog or release notes are optional and up to the
> package maintainer. Some packages have them either in separate files,
> in their info documentation, or included as comment in the package's
> main file.
Yes, in my packages i include a “;;; Commentary:” section at the start
of the main package file, containing Markdown within comments, that
`el2markdown`:
https://github.com/Lindydancer/el2markdown
uses to generate the README.md file containing the package
documentation.
Alexis.
next reply other threads:[~2015-09-10 11:40 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-09-10 11:40 Alexis [this message]
[not found] <vto7ccx8r5.ln2@news.c0t0d0s0.de>
2015-09-10 9:22 ` Packages, release notes, etc Tassilo Horn
2015-09-10 17:36 ` Stefan Monnier
2015-09-10 20:09 ` Tassilo Horn
2015-09-10 23:20 ` Stefan Monnier
[not found] ` <mailman.878.1441927224.19560.help-gnu-emacs@gnu.org>
2015-09-11 2:12 ` Pascal J. Bourguignon
2015-09-11 9:25 ` Alan Schmitt
2015-09-11 5:26 ` tomas
[not found] ` <mailman.874.1441915758.19560.help-gnu-emacs@gnu.org>
2015-09-11 0:16 ` Joost Kremers
2015-09-11 2:15 ` Pascal J. Bourguignon
[not found] ` <mailman.808.1441876951.19560.help-gnu-emacs@gnu.org>
[not found] ` <ni18ccxbua.ln2@news.c0t0d0s0.de>
2015-09-10 10:31 ` tomas
2015-09-10 11:00 ` Tassilo Horn
2015-09-10 11:38 ` tomas
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=87mvwu4i4w.fsf@gmail.com \
--to=flexibeast@gmail.com \
--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).