Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Reduce friction around using roxygen2 + markdown #911

Closed
batpigandme opened this issue Oct 14, 2019 · 2 comments
Closed

Reduce friction around using roxygen2 + markdown #911

batpigandme opened this issue Oct 14, 2019 · 2 comments
Labels
docs 💡 documentation, news, vignettes, website, etc feature a feature request or enhancement

Comments

@batpigandme
Copy link
Contributor

batpigandme commented Oct 14, 2019 •
edited
Loading

i.e. have use_roxygen_md() insert Roxygen: list(markdown = TRUE) at the bottom of DESCRIPTION without having to run roxygen2md::roxygen2md()
@batpigandme batpigandme changed the title Turn on markdown formatting for roxygen by default Turn on roxygen markdown formatting from use_roxygen_md() Oct 14, 2019
@jennybc
Copy link
Member

jennybc commented Oct 14, 2019

Or was the suggestion to (also) just put this in our default DESCRIPTION? @hadley

@hadley
Copy link
Member

hadley commented Oct 14, 2019

Yeah we should turn it on by default and polish the other function a bit

@jennybc jennybc changed the title Turn on roxygen markdown formatting from use_roxygen_md() Reduce friction around using roxygen2 + markdown Oct 14, 2019
@hadley hadley added docs 💡 documentation, news, vignettes, website, etc feature a feature request or enhancement labels Oct 16, 2019
@hadley hadley closed this as completed in a905dd9 Oct 16, 2019
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
docs 💡 documentation, news, vignettes, website, etc feature a feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hadley @jennybc @batpigandme