rcannood / princurve

Fits a Principal Curve in Arbitrary Dimension ⤵
41 stars 6 forks source link

FYI: NEWS.md is not found by news() #13

Closed HenrikBengtsson closed 6 years ago

HenrikBengtsson commented 6 years ago

I noticed you Markdown-ified NEWS to NEWS.md. Several packages do this and CRAN parses it and renders it in HTML online. Unfortunately, it also breaks news() who will not find it, cf. https://github.com/HenrikBengtsson/Wishlist-for-R/issues/40;

> news(package = "princurve")
NULL
HenrikBengtsson commented 6 years ago

Maybe it's possible to have a copy NEWS of NEWS.md and keep both under inst/.

rcannood commented 6 years ago

Thanks for bringing this up.

I noticed this too, but preferred to have the news more legible on GitHub than have it work with news(). Although you're right, there's no reason why I shouldn't make both work.

What do you think about this solution? feature/improve_news (Diff). Would this be the most useful solution for both users and developers?

By the way, I really like Wishlist-for-R :+1: I wish more issues were closed, though.

HenrikBengtsson commented 6 years ago

Thanks. I think it's important to support news() - this looks like a nice workaround.

PS. Yeah, there are a few things that can/should be fixed in that Wishlist-for-R. I'm and others are adding things there as they are discovered and eventually the issues mature and can be turned into a solid bug report/patch that R core can take quick action on.