search

nimble-dev / nimble

The base NIMBLE package for R
http://R-nimble.org
BSD 3-Clause "New" or "Revised" License
156 stars 23 forks source link

update nimble-package Roxygen #1359

Closed paciorek closed 8 months ago

paciorek commented 10 months ago

Request from CRAN:

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

if remaining with the old approach.

paciorek commented 10 months ago

Fixed. Need to check that help(nimble) works correctly when rebuild man pages. Leave open until then.