search

NIEHS / beethoven

BEETHOVEN is: Building an Extensible, rEproducible, Test-driven, Harmonized, Open-source, Versioned, ENsemble model for air quality
https://niehs.github.io/beethoven/
Other
4 stars 0 forks source link

Activate roxygen2 markdown syntax #267

Closed sigmafelix closed 7 months ago

sigmafelix commented 7 months ago

According to this link, roxygen2 documentation can accept markdown syntax if the following entry is added to DESCRIPTION.

Roxygen: list(markdown = TRUE)

I noticed parts of our roxygen2 documentation included markdown syntax and I have been trying to modifying them into the standard Rd syntax (LaTeX-esque). Addition of that line will help us to write roxygen documentation more efficiently (and to save our fingers and wrists a bit as well 😄). I will reflect this in the upcoming push.

Before

image

After

image
sigmafelix commented 7 months ago

Included in PR #252 . On hold until all checks are passed.