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

document _PACKAGE to get all the defaults for package documentation #155

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

document _PACKAGE to get all the defaults for package documentation #155

FvD opened this issue Aug 19, 2023 · 1 comment
Assignees

Comments

@FvD
Copy link
Member

FvD commented Aug 19, 2023

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

@FvD FvD self-assigned this Aug 19, 2023
@FvD
Copy link
Member Author

FvD commented Oct 29, 2023

Solved using the following (second line to replace the @importFrom in the ixplorer.R file.

usethis::use_package_doc()
usethis::use_import_from("dplyr", "%>%")

I deleted the ixplorer.R file (I did not see that mentioned in the documentation, but it makes no sense to leave the "old approach there". To delete I moved the utils::globalVariables() line to ixplorer-package.R.

@FvD FvD closed this as completed Oct 29, 2023
FvD added a commit to FvD/ixplorer that referenced this issue Oct 29, 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