Support for NEWS.md - Githubissues

lgatto commented 6 years ago

Starting with the R devel, NEWs.md will be supported by news() - see here for details.. We might consider updating or removing the news recipe and or document that it might not be required any more.

sgibb commented 6 years ago

You are right (the corresponding R/NEWS entry https://developer.r-project.org/blosxom.cgi/R-devel/NEWS/2018/08/07#n2018-08-07). I guess it will be part of 3.5.2. I would suggest to just remove the target when it becomes part of the stable R release (hopefully we will remember to do this. (Would be great if github could send reminders; see https://probot.github.io/apps/reminders/ (I already clicked "install" for maker).)

lgatto commented 6 years ago

Didn't know about these reminders, nice. ~~Did you set one? Not sure what you mean in clicked install.~~ Ignore that one, I got the request.

lgatto commented 6 years ago

There's one think though that the target does and that is still useful, which is removing the URL syntax upon conversion from md to plain text. I doubt the links will be displayed properly using news() or on the Bioconductor/CRAN pages.

sgibb commented 6 years ago

fair point /remind me to look into this after I updated my R-devel installation tomorrow

reminders[bot] commented 6 years ago

@sgibb set a reminder for Oct 3rd 2018

reminders[bot] commented 6 years ago

:wave: @sgibb, look into this after I updated my R-devel installation

sgibb commented 6 years ago

@lgatto It seems that R is doing the right thing (keep the link in HTML and remove the url in text mode) and we could simply remove the target:

library("MSnbase")

nw <- news(Version == 2.7, package="MSnbase")

print(nw)

print(nw, doBrowse=FALSE)
#                          Changes in version 2.7
#
# Changes in version 2.7.2
#
#   - Add internal fragmentation support in calculateFragments; see #82
#     <2016-03-26 Sat>
#
# Changes in version 2.7.1
#
#   - Handle files without any spectra - see #342 <2018-05-15 Tue>
#   - New mergeFeatureVars and expandFeatureVars functions <2018-05-30
#     Wed>
#
# Changes in version 2.7.0
#
#   - New devel version for Bioc 3.8

str(nw)
# Classes ‘news_db_from_md’, ‘news_db’ and 'data.frame':    3 obs. of  5 variables:
#  $ Version : chr  "2.7" "2.7" "2.7"
#  $ Date    : chr  NA NA NA
#  $ Category: chr  "Changes in version 2.7.2" "Changes in version 2.7.1" "Changes in version 2.7.0"
#  $ Text    : chr  "  - Add internal fragmentation support in calculateFragments; see #82\n    <2016-03-26 Sat>" "  - Handle files without any spectra - see #342 <2018-05-15 Tue>\n  - New mergeFeatureVars and expandFeatureVar"| __truncated__ "  - New devel version for Bioc 3.8"
#  $ HTML    : chr  "<ul>\n<li>Add internal fragmentation support in calculateFragments; see <a href=\"https://github.com/lgatto/MSn"| __truncated__ "<ul>\n<li>Handle files without any spectra - see\n<a href=\"https://github.com/lgatto/MSnbase/issues/342\">#342"| __truncated__ "<ul>\n<li>New devel version for Bioc 3.8</li>\n</ul>\n"
#  - attr(*, "package")= chr "MSnbase"
#  - attr(*, "subset")= logi  TRUE TRUE TRUE FALSE FALSE FALSE ...
# NULL

/remind me to remove the NEWS target when R 3.5.2 will have been released in November

reminders[bot] commented 6 years ago

@sgibb set a reminder for Nov 1st 2018

lgatto commented 6 years ago

Looks great! Yes, it's safe to remove that recipe once that feature is in R release. Or possibly replace it with a note linking to this issue before removing it altogether?