Closed brendanf closed 9 months ago
Use @aliases hello-package
to override
Came here via https://github.com/r-lib/pkgdown/issues/1414
So should the fix be documentation of the tip above or something else?
I think it should be fixed in roxygen2.
Hi all, I also just experienced the same issue and solved it by following David's comment here: https://github.com/tidymodels/hardhat/issues/130#issuecomment-622438758
Fixing this is going to require some thought, because we currently add the default aliases in object_defaults.package
, where the full set of aliases used by the package isn't know.
I think we'd need to add something to roclet_process.roclet_rd
that gets all aliases across topics, and then adds aliases to the package doc if they're otherwise missing.
There seems to have been a reversion sometime since this Stack Exchange answer was given; now when I make a new package
hello
usinghello/R/hello.R
:and
hello/DESCRIPTION
:and then build documentation, I get the following
hello/man/hello-package.Rd
:The
\alias{hello}
line conflicts with documentation forhello()
, resulting in theR CMD check
warningRd files with duplicated alias 'hello': ‘hello-package.Rd’ ‘hello.Rd’