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 syntax of package overview help file #36

Closed
DDorch opened this issue Aug 19, 2023 · 1 comment
Closed

Incorrect syntax of package overview help file #36

DDorch opened this issue Aug 19, 2023 · 1 comment
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation duplicate This issue or pull request already exists
Milestone

Comments

@DDorch
Copy link
Collaborator

DDorch commented Aug 19, 2023

Sujet : CRAN package hubeau
Sat, 19 Aug 2023 10:49:16 +0200 (CEST)
Kurt Hornik



Dear maintainer,

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

@DDorch DDorch added this to the v0.5.0 milestone Aug 19, 2023
@DDorch DDorch self-assigned this Aug 19, 2023
@DDorch DDorch added bug Something isn't working documentation Improvements or additions to documentation labels Aug 19, 2023
@DDorch DDorch added the duplicate This issue or pull request already exists label Feb 22, 2024
@DDorch
Copy link
Collaborator Author

DDorch commented Feb 22, 2024

Duplicates #43

@DDorch DDorch closed this as completed Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation duplicate This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

1 participant