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

CRAN-blocking bug re a documentation alias #62

Closed
dankelley opened this issue Aug 19, 2023 · 2 comments
Closed

CRAN-blocking bug re a documentation alias #62

dankelley opened this issue Aug 19, 2023 · 2 comments
Assignees
Projects

Comments

@dankelley
Copy link
Contributor

I got as below for this and all the R packages that I maintain. I'll fix this up sometime today, likely starting with another package (plan) which is tiny and which will therefore go through tests quickly.


Dear maintainer,

You have file 'gsw/man/gsw.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
<https://github.com/r-lib/roxygen2/issues/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 gsw-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
@dankelley dankelley self-assigned this Aug 19, 2023
@github-actions github-actions bot added this to To do in Issues Aug 19, 2023
@dankelley
Copy link
Contributor Author

I've done a test for the plan package (see dankelley/plan#30) and I'll wait a day or so to see if that seems to have caused other problems.

@dankelley
Copy link
Contributor Author

Fixed in "develop" branch, issue 2b662aa. A test follows.

$ Rscript -e "package?gsw"|head
gsw                    package:gsw                     R Documentation

R implementation of Thermodynamic Equation Of Seawater - 2010 (TEOS-10)

Description:

     Provides an R interface to the TEOS-10 / GSW (Gibbs Sea Water)
     library, partly for use by the ‘oce’ package (see
     <https://dankelley.github.io/oce/>) and partly for general use. It
     is assumed that users are familiar with the science and

Issues automation moved this from To do to Done Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Issues
  
Done
Development

No branches or pull requests

1 participant