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 roxygen2 from CRAN email #204

Merged
merged 1 commit into from
Aug 19, 2023
Merged

Update roxygen2 from CRAN email #204

merged 1 commit into from
Aug 19, 2023

Conversation

mikemahoney218
Copy link
Member

From Kurt Hornik this morning:

Dear maintainer,

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

@mikemahoney218 mikemahoney218 merged commit de9da36 into main Aug 19, 2023
8 checks passed
@mikemahoney218 mikemahoney218 deleted the update_roxygen branch August 19, 2023 17:14
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.

None yet

1 participant