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

Convert roxygen2 comments to markdown #57

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Convert roxygen2 comments to markdown #57

merged 1 commit into from
Aug 29, 2024

Conversation

SaranjeetKaur
Copy link
Collaborator

Turn on Markdown support for the healthgpsrvis package :

  1. Since we’re updating an existing package, running usethis::use_roxygen_md() will modify the DESCRIPTION (to include Roxygen: [list](https://rdrr.io/r/base/list.html)(markdown = TRUE)) and prompt us to use the roxygen2md package to convert the existing docs.
  2. Once the package roxygen2md is downloaded, run roxygen2md::roxygen2md() to convert existing Rd comments to markdown.
  3. Run devtools::document() when you're done.
  4. Finally run devtools::check().

@SaranjeetKaur SaranjeetKaur self-assigned this Aug 29, 2024
@SaranjeetKaur SaranjeetKaur merged commit 7cec460 into main Aug 29, 2024
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant