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.

Sign up for GitHub

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

Jump to bottom

Use Markdown for function documentation #54

Open
peterdesmet opened this issue Feb 27, 2019 · 0 comments
Open

Use Markdown for function documentation #54

peterdesmet opened this issue Feb 27, 2019 · 0 comments

Comments

@peterdesmet
Copy link
Member

I didn't know this, but you can use Markdown in addition to Roxygen syntax for function document: http://klutometis.github.io/roxygen/articles/markdown.html, by adding to DESCRIPTION:

Roxygen: list(markdown = TRUE)

It basically gets rid of all the something{text} syntax, making it easier to write and read.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@peterdesmet