From csardi.gabor at gmail.com  Sat May 23 20:22:31 2015
From: csardi.gabor at gmail.com (=?UTF-8?B?R8OhYm9yIENzw6FyZGk=?=)
Date: Sat, 23 May 2015 14:22:31 -0400
Subject: [Rd] NEWS.md support on CRAN
In-Reply-To: <CANROs4c9-w_gdsoP-7VVfD3Zm94V+P1Ej-Qtiaqu6JgDCoC5nw@mail.gmail.com>
References: <4819669E-8260-47B0-96BF-DC2B29E6BE21@me.com>
	<555FD2FE.8050600@gmail.com>
	<21856.13500.513608.759602@fangorn.hornik.net>
	<55606F19.3080106@gmail.com>
	<CABtg=KkjFu7Jn8xJqQjyn5bRD8nJG_aJ-QS6ET4BY+ic_d3SBw@mail.gmail.com>
	<CANROs4c9-w_gdsoP-7VVfD3Zm94V+P1Ej-Qtiaqu6JgDCoC5nw@mail.gmail.com>
Message-ID: <CABtg=Kk+y_1ME-ERdP3GChjGufw0kybjzvqazvTgAyefmRAr7A@mail.gmail.com>

On Sat, May 23, 2015 at 11:31 AM, Yihui Xie <xie at yihui.name> wrote:

> I agree. It is not worth all the trouble just to save the "bit of
> hassle to go to the package's Github site". In fact, the release notes
> on Github are more meaningful than a plain text NEWS.md or even a
> converted NEWS.html from Pandoc, e.g. you can include bug report
> numbers and attribute to users by @username (they all have hyperlinks
> attached on them, so it is easy to see more details of bugs/features
> if one really cares).


Indeed. Although the GitHub API I linked can build a HTML that includes
these links, and that's already pretty good.

[...]

> Re Kurt's analysis of NEWS.md on CRAN, I guess that is because R CMD
> check will warn against NEWS.md at the top level. I know a lot of
> packages on Github have the NEWS.md file, and it has been removed from
> the tarball to make R CMD check happy.
>

I agree. The only package with inst/NEWS.md on CRAN is in fact mine
(crayon), and I put NEWS.md (and README.md) in inst/ so that

1) R CMD check and CRAN are both happy (CRAN was unhappy about non-valid
HTML build by Pandoc from README.md), and

2) they are included in the package.

Gabor

	[[alternative HTML version deleted]]



[Rd] NEWS.md support on CRAN
=?UTF-8?B?R8OhYm9yIENzw6FyZGk=?=