-
-
Notifications
You must be signed in to change notification settings - Fork 3
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
Check roxygen documentation #168
Conversation
Code Coverage Summary
Diff against main
Results for commit: 2ce2d4f Minimum allowed coverage is ♻️ This comment has been updated with latest results |
Unit Tests Summary 1 files 64 suites 10s ⏱️ Results for commit 2ce2d4f. ♻️ This comment has been updated with latest results. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the incredibly thoughtful and thorough review!
What changes are proposed in this pull request?
@return
and@examples
fields are present, no missing documentation pages, no typos, and consistent documentation of parameters. Also added function links where applicable.This PR is pretty big - I can break it up if you prefer to review smaller pieces at a time!
Closes #149
Pre-review Checklist (if item does not apply, mark is as complete)
usethis::pr_merge_main()
devtools::test_coverage()
Reviewer Checklist (if item does not apply, mark is as complete)
pkgdown::build_site()
. Check the R console for errors, and review the rendered website.devtools::test_coverage()
When the branch is ready to be merged:
NEWS.md
with the changes from this pull request under the heading "# cards (development version)
". If there is an issue associated with the pull request, reference it in parentheses at the end update (seeNEWS.md
for examples).