Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use markdown in roxygen comments #42

Open
spencerpease opened this issue Apr 17, 2019 · 0 comments
Open

Use markdown in roxygen comments #42

spencerpease opened this issue Apr 17, 2019 · 0 comments
Labels
enhancement New feature or request Idea

Comments

@spencerpease
Copy link
Contributor

Description

Starting from version 6.0.0, roxygen supports markdown markup within most roxygen tags. Roxygen uses the commonmark package, which is based on the CommonMark Reference Implementation to parse these tags.

This would help make comments more concise and readable, since \emph{foo} could be replaced by **foo**, \code{bar} would become bar (just in backticks), and \code{\link[=func]{func()} becomes [func()].

The roxygen tags @md and @noMd to parse roxygen chunks with/without markdown for a single chunk.

References

https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html

@spencerpease spencerpease added enhancement New feature or request Idea labels Apr 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Idea
Projects
None yet
Development

No branches or pull requests

1 participant