Generating \alias{_PACKAGE} when adding @aliases {pkgname}-package to package documentation

[mbojan]

Related to #1160.

In case a package pkgname includes a function pkgname() a strategy to avoid duplicated Rd alias pkgname is to "manually" add @aliases pkgname-package to R/pkgname-package.R. However, this also produces \alias{_PACKAGE} in the corresponding Rd file. For example this source file:

https://github.com/mbojan/roxypackagedoc/blob/0906e7f7d37147bdc3e906341a9530955a3f83d8/R/roxypackagedoc-package.R#L1-L9

#' Testing erroneous alias generation
#'
#' @aliases roxypackagedoc-package
#' @keywords internal
"_PACKAGE"

## usethis namespace: start
## usethis namespace: end
NULL

Produces (roxygen2 7.1.2) this Rd:

https://github.com/mbojan/roxypackagedoc/blob/0906e7f7d37147bdc3e906341a9530955a3f83d8/man/roxypackagedoc-package.Rd#L1-L11

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/roxypackagedoc-package.R
\docType{package}
\name{roxypackagedoc-package}
\alias{roxypackagedoc-package}
\alias{_PACKAGE}
\title{Testing erroneous alias generation}
\description{
Test for roxygen2 error when generating pkgname-package man page.
}
\keyword{internal}

c.f. dummy package https://github.com/mbojan/roxypackagedoc

[hadley]

In the mean time, you can work around this by doing #' @aliases roxypackagedoc-package NULL

[mbojan]

OK! Thanks @hadley .

[hadley]

I think it's probably easiest to just document this pattern.