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

Update package help documentation #105

Open
leppott opened this issue Feb 22, 2024 · 0 comments
Open

Update package help documentation #105

leppott opened this issue Feb 22, 2024 · 0 comments

Comments

@leppott
Copy link
Owner

leppott commented Feb 22, 2024

See penultimate section header on this blog for more info on the issue from CRAN.

https://www.r-bloggers.com/2023/08/ropensci-news-digest-august-2023/

In BioMonTools.R file change

from

#' @docType package
#' @name BioMonTools

to

"_PACKAGE"`

From another package:

Dear maintainer,

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

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