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

Incorrect package alias #59

Open
aravindhebbali opened this issue Aug 23, 2023 · 0 comments
Open

Incorrect package alias #59

aravindhebbali opened this issue Aug 23, 2023 · 0 comments
Assignees
Labels
docs This issue or pull request already exists

Comments

@aravindhebbali
Copy link
Member

From CRAN:

Dear maintainer,

You have file 'rbin/man/rbin.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
<https://github.com/r-lib/roxygen2/issues/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 rbin-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
@aravindhebbali aravindhebbali added the docs This issue or pull request already exists label Aug 23, 2023
@aravindhebbali aravindhebbali self-assigned this Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

1 participant