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

Adopt _PACKAGE sentinel for package documentation #1136

Merged
merged 1 commit into from
Dec 1, 2023
Merged

Conversation

kylebaron
Copy link
Collaborator

@kylebaron kylebaron commented Dec 1, 2023

This PR adopts the "_PACKAGE" approach. See r-lib/roxygen2#1491

Dear maintainer,

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

Copy link
Contributor

@kyleam kyleam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kylebaron kylebaron merged commit 791e740 into main Dec 1, 2023
@kylebaron
Copy link
Collaborator Author

Thanks, @kyleam

@kylebaron kylebaron linked an issue Dec 8, 2023 that may be closed by this pull request
@kylebaron kylebaron deleted the mrgsolve-package branch December 14, 2023 14:42
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

Successfully merging this pull request may close these issues.

PKGNAME alias
2 participants