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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update Roxygen version #128

wants to merge 4 commits into from

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
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