ajschumacher / rjstat

read and write JSON-stat with R
Other
31 stars 6 forks source link

appropriate PKGNAME-package \alias #22

Closed ajschumacher closed 1 year ago

ajschumacher commented 1 year ago

I got an email from Kurt Hornik on 2023-08-19:


Dear maintainer,

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


@hmalmedal / @MansMeg can you address?

hmalmedal commented 1 year ago

@ajschumacher I made a fix and uploaded a new version to CRAN in your name. You will be sent an e-mail you must confirm.

ajschumacher commented 1 year ago

@hmalmedal confirmed! 👍👍👍

Also, do you want to take over maintainership officially? I haven’t really been doing anything here for some time; if you’re willing it seems like it would be more efficient to take me out of the loop… What do you think?

hmalmedal commented 1 year ago

I am willing to take over if that is what you want.

ajschumacher commented 1 year ago

I think it makes sense; I leave it to you! 😄