help-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Packages, release notes, etc


From: Alexis
Subject: Re: Packages, release notes, etc
Date: Thu, 10 Sep 2015 21:40:31 +1000

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.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]