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

Update Roxygen version #128

Merged
merged 4 commits into from
Nov 18, 2024
Merged

Update Roxygen version #128

merged 4 commits into from
Nov 18, 2024

Conversation

Moohan
Copy link
Member

@Moohan Moohan commented Jul 1, 2024

I also followed the advice to remove the deprecated tag @docType package and instead document the special object "_PAKCAGE". I used usethis::use_package_doc() for this and then moved the @importFroms.

The change for users here is that the top-level documentation available to users in R should be easier to get to (more aliases) and will have better content (since it will now auto-populate from the DESCRIPTION file.

I also followed the advice to remove the deprecated tag `@docType package` and instead document the special object `"_PAKCAGE"`. I used `usethis::use_package_doc()` for this and then moved the `@importFrom`s.

The change for users here is that the top-level documentation available to users in R should be easier to get to (more aliases) and will have better content (since it will now auto-populate from the DESCRIPTION file.
@Moohan Moohan added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 1, 2024
@Moohan Moohan requested review from Tina815 and Nic-Chr October 21, 2024 10:14
@Tina815 Tina815 merged commit d816bed into master Nov 18, 2024
16 checks passed
@Tina815 Tina815 deleted the doc/update_roxygen_version branch November 18, 2024 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants