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 greta package alias #590

Closed
njtierney opened this issue Nov 7, 2023 · 1 comment
Closed

fix greta package alias #590

njtierney opened this issue Nov 7, 2023 · 1 comment
Milestone

Comments

@njtierney
Copy link
Collaborator

njtierney commented Nov 7, 2023

Dear maintainer,

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

if remaining with the old approach.

@njtierney njtierney added this to the 0.5.0 milestone Jan 17, 2024
@njtierney
Copy link
Collaborator Author

fixed in #602

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

1 participant