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

roxygen related fix needed from CRAN #108

Closed
AlisonLanski opened this issue Aug 19, 2023 · 1 comment · Fixed by #111
Closed

roxygen related fix needed from CRAN #108

AlisonLanski opened this issue Aug 19, 2023 · 1 comment · Fixed by #111
Assignees
Labels
bug Something isn't working

Comments

@AlisonLanski
Copy link
Owner

Email from Kurt Hornik

You have file 'IPEDSuploadables/man/IPEDSuploadables.Rd' with
\docType{package}, likely intended as a package overview help file, but
without the appropriate PKGNAME-package \alias as per "Documenting
packages" in R-exts.

This seems to be the consequence of the breaking change

Using @doctype package no longer automatically adds a -package alias.
Instead document _PACKAGE to get all the defaults for package
documentation.

in roxygen2 7.0.0 (2019-11-12) having gone unnoticed, see
r-lib/roxygen2#1491.

As explained in the issue, to get the desired PKGNAME-package \alias
back, you should either change to the new approach and document the new
special sentinel

"_PACKAGE"

or manually add

@Aliases IPEDSuploadables-package

if remaining with the old approach.

Please fix in your master sources as appropriate, and submit a fixed
version of your package within the next few months.

@AlisonLanski AlisonLanski added the bug Something isn't working label Aug 19, 2023
@AlisonLanski AlisonLanski added this to the Fall Collection milestone Aug 19, 2023
@AlisonLanski AlisonLanski self-assigned this Aug 19, 2023
@AlisonLanski
Copy link
Owner Author

went with alias approach

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant