search

ycphs / openxlsx

openxlsx - a fast way to read and write complex xslx files
https://ycphs.github.io/openxlsx/
Other
226 stars 75 forks source link

Use `roxygen2md` #290

Closed jmbarbone closed 3 years ago

jmbarbone commented 3 years ago

Changes made from roxygen2md::roxygen2md() with a little clean up

JanMarvin commented 3 years ago

Looks fine to me, though please help my friend here who does not know what is the benefit of this. Is it to adapt a specific format?

jmbarbone commented 3 years ago

Looks fine to me, though please help my friend here who does not know what is the benefit of this. Is it to adapt a specific format?

Use of the markdown config for Roxygen is a bit more popular and can be easier to use for R's documentation. Linking specifically feels a lot easier: https://roxygen2.r-lib.org/articles/markdown.html#links (you're friend might like this)

It also looks a bit prettier, and less crowed in the .R file:

Without ![image](https://user-images.githubusercontent.com/38573843/140818254-dee89aff-4b36-45a6-b8ae-1bf5eee02428.png)
With ![image](https://user-images.githubusercontent.com/38573843/140818313-086d8ef6-c5b5-45c7-a094-10934d5098fc.png)
JanMarvin commented 3 years ago

Thanks! I agree it looks cleaner. Merging it