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

Package-level documentation alias collides with others without warning #1320

Closed
netique opened this issue Dec 27, 2020 · 1 comment
Closed

Comments

@netique
Copy link

netique commented Dec 27, 2020

When user wants to build package-level documentation page and there is a function with the same name (which could be quite common), roxygen2 generates two .Rd pages with the same \aliases. This could be a foundation of many problems (see issues https://github.com/r-lib/pkgdown/issues/1459 and r-lib/downlit#73 for real-life reference).

usethis::use_package_doc()

I do not know how to solve it, but a user should be warned at least of possible consequences. There could be option to use different alias as well.

@jennybc
Copy link
Member

jennybc commented Dec 28, 2020

Duplicate of #1170, which concludes the best place the address this definitely is in roxygen2

@jennybc jennybc closed this as completed Dec 28, 2020
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

No branches or pull requests

2 participants