From kevinushey at gmail.com  Sun May 24 20:15:20 2015
From: kevinushey at gmail.com (Kevin Ushey)
Date: Sun, 24 May 2015 11:15:20 -0700
Subject: [Rd] NEWS.md support on CRAN
In-Reply-To: <CANROs4c81FW1OR-g4trWPdtzMopR94FBSFLpEBbbiKXdfdw+FA@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>
	<5561148C.7030205@gmail.com>
	<CANLFJPqcFO6EJyjmmW2CFWG1C+QMgz+GMSQi+qpKW8+3K17CAA@mail.gmail.com>
	<7D4658B5-AE08-4477-93CE-4EE946444FA0@me.com>
	<55613244.8040407@gmail.com>
	<C93B1DF2-6D4F-4333-8CCF-C2036FA2B6A9@me.com>
	<5561B3E6.3060803@gmail.com> <5561CAFB.1060006@gmail.com>
	<CANROs4c81FW1OR-g4trWPdtzMopR94FBSFLpEBbbiKXdfdw+FA@mail.gmail.com>
Message-ID: <CAJXgQP072aoPm-_ZGkQmSd+pr2zV6O7rLXzhvNptyuJc8WANDg@mail.gmail.com>

I like the idea of supporting a small, strict subset of Markdown that
can be used to translate from NEWS.md to NEWS.

Following from Yihui's example, it would be pretty easy to write a
parser in R for such a format (and I'd be willing to try implementing
one, if that would be of interest).

Kevin

On Sun, May 24, 2015 at 10:20 AM, Yihui Xie <xie at yihui.name> wrote:
> That is more or less what I had been doing for a long time (having
> both NEWS.md and NEWS), but decided not to do it any more last year.
> In fact, you can easily convert NEWS.md to a NEWS file that R's news()
> can understand, e.g.
> https://github.com/yihui/knitr/blob/947ad5fc94/Makefile#L8-L10 (if
> your NEWS.md is like this
> https://raw.githubusercontent.com/yihui/knitr/947ad5fc94/NEWS.md)
>
> I stopped doing this because as I said, I found Github release notes
> much more pleasant to read (https://github.com/yihui/knitr/releases),
> and I do not care much about the possibility that some users do not
> have internet connections when reading the NEWS (it is a legitimate
> concern, though). IMHO, it is totally worth it if we are talking about
> official support of Markdown in R's documentation system (.Rd files),
> and it is probably not worth the time and effort if we only want to
> support NEWS.md in particular. That is just a tiny problem compared to
> the effort of porting CommonMark or whatever Markdown rendering
> engines into R.
>
> Regards,
> Yihui
>
>
> On Sun, May 24, 2015 at 7:58 AM, Duncan Murdoch
> <murdoch.duncan at gmail.com> wrote:
>>
>> I imagine GitHub users could have both NEWS.md and NEWS, with one being
>> a symlink to the other, and .Rbuildignore set to ignore NEWS.md.  Why
>> not try it, and post instructions for other Github users?  news() won't
>> be able to understand the headings, but it should display the file as a
>> bunch of text.
>>
>> Duncan Murdoch
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel



[Rd] NEWS.md support on CRAN
Kevin Ushey