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

Fix deprecated roxygen2 pkg-level documentation in pkg and template #103

Merged
merged 5 commits into from
Mar 30, 2024
Merged

Fix deprecated roxygen2 pkg-level documentation in pkg and template #103

merged 5 commits into from
Mar 30, 2024

Conversation

slager
Copy link
Contributor

@slager slager commented Mar 27, 2024

DataPackageR currently uses package-level documentation syntax that has been deprecated in roxygen2 since ~2019. It uses this both for its own package-level documentation and in its template for creating new data package skeletons.

With recent versions of roxygen2, e.g. 7.3.1, the warning surfaces both during routine building of data packages and during R CMD check.

✖ Schief546.R:13: `@docType "package"` is deprecated.
ℹ Please document "_PACKAGE" instead.

517198f fixes the data package skeleton template. Keeping the @name tag is not required by roxygen2 but is necessary for fragile-looking downstream scraping functionality in DataPackageR to still work without modifications.

95957a0 fixes DataPackageR's own documentation. The new method auto-generates some additional author info etc. for the package-level .Rd file.

One broken unit test needed to be updated to be be more robust.

I installed this branch locally and did a test build of Schief546 to verify that the build still works and the warning no longer appears. With this PR, the package also passes devtools::check() cleanly on my local machine.

This is probably not directly relevant to DPR2, since @jmtaylor-fhcrc et al. have presumably been using newer roxygen2 versions.

@slager
Copy link
Contributor Author

slager commented Mar 27, 2024

It looks like an alternative fix for the same test was also done in bdd362c

@slager
Copy link
Contributor Author

slager commented Mar 30, 2024

Fixes #98. Merging to reinstate CI on develop and facilitate testing the 2 other PRs.

Will eventually want to revert either 85f441d or Marie's fix bdd362c, since these duplicate each other in fixing #98.

@slager slager merged commit d0f0b63 into ropensci:develop Mar 30, 2024
6 checks passed
@slager slager deleted the pkg_doc_fix branch March 30, 2024 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant