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

Need chromer-package alias #38

Closed
kbroman opened this issue Aug 19, 2023 · 0 comments
Closed

Need chromer-package alias #38

kbroman opened this issue Aug 19, 2023 · 0 comments

Comments

@kbroman
Copy link
Member

kbroman commented Aug 19, 2023

Problem reported by CRAN:

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

if remaining with the old approach.

kbroman added a commit to kbroman/chromer that referenced this issue Aug 20, 2023
@kbroman kbroman closed this as completed Aug 20, 2023
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

No branches or pull requests

1 participant