Skip to content

Package Documentation #36

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

Closed
the-mayer opened this issue Aug 23, 2023 · 0 comments
Closed

Package Documentation #36

the-mayer opened this issue Aug 23, 2023 · 0 comments
Assignees

Comments

@the-mayer
Copy link
Collaborator

file 'ReviewR/man/ReviewR.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://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fr-lib%2Froxygen2%2Fissues%2F1491&data=05%7C01%7Cdavid.mayer%40cuanschutz.edu%7Cbfb5d5046ed44ff2e6a908dba08faa46%7C563337caa517421aaae01aa5b414fd7f%7C0%7C0%7C638280311137676416%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=iAQ%2FuF9RLl31U7OLuZSTzpg1QLSnwcq0OnHL93s0Aws%3D&reserved=0.

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 ReviewR-package

if remaining with the old approach.

@the-mayer the-mayer added the enhancement New feature or request label Aug 23, 2023
@the-mayer the-mayer self-assigned this Aug 23, 2023
@the-mayer the-mayer added documentation and removed enhancement New feature or request labels Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant