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 required to package overview help file #21

Closed
elimillera opened this issue Aug 21, 2023 · 0 comments · Fixed by #22
Closed

Update required to package overview help file #21

elimillera opened this issue Aug 21, 2023 · 0 comments · Fixed by #22
Assignees

Comments

@elimillera
Copy link
Collaborator

Received the following from CRAN:

Dear maintainer,

You have file 'tidytlg/man/tidytlg.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 tidytlg-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.

@elimillera elimillera self-assigned this Aug 21, 2023
elimillera added a commit that referenced this issue Aug 28, 2023
elimillera added a commit that referenced this issue Aug 31, 2023
Updates per #21 fixing CRAN issue.
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 a pull request may close this issue.

1 participant