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 package alias #148

Closed
jrnold opened this issue Nov 19, 2023 · 0 comments
Closed

Fix package alias #148

jrnold opened this issue Nov 19, 2023 · 0 comments
Assignees

Comments

@jrnold
Copy link
Owner

jrnold commented Nov 19, 2023

Dear maintainer,

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

Best,
-k

@jrnold jrnold self-assigned this Nov 19, 2023
jrnold pushed a commit that referenced this issue Nov 20, 2023
Add ggthemes-package alias to docs
@jrnold jrnold closed this as completed in 6d982cd Nov 20, 2023
jrnold pushed a commit that referenced this issue Feb 8, 2024
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